<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
<html><head>














 










 
 
 

 

  




  
    
<meta http-equiv="content-type" content="text/html; charset=utf-8"><title>OpenSocial API Reference (v0.8) - OpenSocial - Google Code</title>

<script type="text/javascript">
(function(){function a(){this.t={};this.tick=function(c){this.t[c]=(new Date).getTime()};this.tick("start")}var b=new a;window.jstiming={Timer:a,load:b};if(window.external&&window.external.pageT)window.jstiming.pt=window.external.pageT;})();

var _tocPath_ = '/html/apis/opensocial/docs/_toc.ezt';
</script>
<link href="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/codesite.css" type="text/css" rel="stylesheet">
<script src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/codesite.js" type="text/javascript"></script>
<link rel="search" type="application/opensearchdescription+xml" title="Google Code" href="http://code.google.com/osd.xml"><!--[if IE]><link rel="stylesheet" type="text/css" href="/css/iehacks.css" /><![endif]--></head><body class="gc-documentation">

    
    
    <div id="gc-container">
<a name="top"></a>
<div id="skipto">
  <a href="#gc-pagecontent">Skip to page content</a>
  <a href="#gc-toc">Skip to main navigation</a>
</div>
<div id="langpref">    
   <a style="text-decoration: none; cursor: pointer;" class="dropdown" href="http://code.google.com/"><span class="title1219980480187" style="text-decoration: underline;">English</span><span style="vertical-align: middle; text-decoration: none; font-family: arial,sans-serif; font-size: 11px;">&nbsp;▼</span></a>
   <span>|</span>
   <a href="http://code.google.com/more/">Site Directory</a>
</div>
<div id="gc-header">
  <div id="logo"><a href="http://code.google.com/">
  
     <img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Google Code Home Page" id="gc-logo-img" height="1" width="1">
  
  </a></div>
  <div id="search">
    <div id="searchForm" class="searchForm" style="">
      <form action="" accept-charset="utf-8" class="gsc-search-box" onsubmit="executeGSearch(document.getElementById('gsearchInput').value); return false;">
        <table class="gsc-search-box" cellpadding="0" cellspacing="0">
          <tbody>
            <tr>
              <td class="gsc-input">
                <input id="gsearchInput" name="q" maxlength="2048" class="gsc-input" autocomplete="off" title="Google Code Search" style="width: 345px;" type="text">
              </td>
              <td class="gsc-search-button">
                <div id="cs-searchresults" onclick="event.cancelBubble = true;"></div>
                <input title="Search" id="gsearchButton" class="gsc-search-button" value="Search" type="submit">
              </td>
            </tr>
            <tr>
              <td class="greytext">e.g. "ajax apis" or "open source"</td>
            </tr>
          </tbody>
        </table>
      </form>
    </div> <!-- end searchForm -->
    <div id="searchForm2" class="searchForm2" style="display: none;">
      <form id="cse" action="http://www.google.com/cse">
        <input name="cref" value="http://code.google.com/cse/googlecode-context.xml" type="hidden">
        <input name="q" maxlength="2048" autocomplete="off" title="Google Code Search" style="width: 345px;" type="text">
        <input name="sa" value="Search" title="Search" type="submit"><br>
        <div class="greytext">e.g. "ajax apis" or "open source"</div>
      </form>
    </div> <!-- end searchForm2 -->
  </div> <!-- end search -->
</div> <!-- end gc-header -->


<div id="codesiteContent">

<a name="gc-topnav-anchor"></a>
<div id="gc-topnav">
  <h1>OpenSocial</h1>
  <ul id="docs" class="gc-topnav-tabs">

    <li id="home_link">
      <a href="http://code.google.com/apis/opensocial/" title="OpenSocial home page">Home</a>
    </li>
  
    <li id="docs_link">
      <a href="http://code.google.com/apis/opensocial/docs/index.html" class="selected" title="Official OpenSocial documentation">Docs</a>
    </li>
  
    <li id="faq_link">
      <a href="http://code.google.com/apis/opensocial/faq.html" title="Answers to frequently asked questions about OpenSocial">FAQ</a>
    </li>
  
    <li id="articles_link">
      <a href="http://code.google.com/apis/opensocial/articles/" title="Focused articles and tutorials for OpenSocial developers">Articles</a>
    </li>
  
    <li>
      <a href="http://opensocialapis.blogspot.com/" title="Official OpenSocial blog">Blog</a>
    </li>
  
    <li>
      <a href="http://groups.google.com/group/opensocial" title="OpenSocial developer forum">Group</a>
    </li>
  
    <li>
      <a href="http://code.google.com/apis/opensocial/terms.html" title="OpenSocial terms of service">Terms</a>
    </li>
  

  </ul>
</div> <!-- end gc-topnav -->

    <div class="g-section g-tpl-210">

      <a name="gc-toc"></a>  
      <div class="g-unit g-first" id="gc-toc">
          <ul class="treelist tlw-nested-only tlw-processed tlw-instance-0">
    <li><a href="http://code.google.com/apis/opensocial/partners.html">Who's Using It?</a></li>
    <li><a href="http://code.google.com/apis/opensocial/gettingstarted.html">Building Social Apps</a></li>
    <li><a href="http://code.google.com/apis/opensocial/container.html">Hosting OpenSocial Apps</a></li>
  </ul>

<div class="line"></div>

<ul class="treelist tlw-nested-only tlw-processed tlw-instance-1">
  <li><h1 class="tlw-ignore">JavaScript API</h1>
    <ul>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/devguide.html">Developer's Guide (v0.7)</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/releasenotes.html">Release Notes (v0.8)</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/spec.html">API Specification (v0.8)</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch selected"><a href="javascript:void(0)" class="tlw-control" title="Collapse API Reference (v0.8)"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Collapse API Reference (v0.8)" class="tlw-control tlw-minus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/">API Reference (v0.8)</a></div><ul style="display: block;" id="1-sub-0">
     <!-- _sidenav.ezt doesn't work with the current scripts. Shakila is working on it. -->
      
<ul>
<li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Collapse opensocial"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Collapse opensocial" class="tlw-control tlw-minus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial">opensocial</a></div><ul style="display: block;" id="1-sub-1">
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Activity"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Activity" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Activity">Activity</a></div><ul style="display: none;" id="1-sub-2">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Activity.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Address"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Address" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Address">Address</a></div><ul style="display: none;" id="1-sub-3">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Address.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand BodyType"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand BodyType" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.BodyType">BodyType</a></div><ul style="display: none;" id="1-sub-4">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.BodyType.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Collection">Collection</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.CreateActivityPriority">CreateActivityPriority</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand DataRequest"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand DataRequest" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest">DataRequest</a></div><ul style="display: none;" id="1-sub-5">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.DataRequestFields">DataRequestFields</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.FilterType">FilterType</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.PeopleRequestFields">PeopleRequestFields</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataRequest.SortOrder">SortOrder</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.DataResponse">DataResponse</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Email"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Email" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Email">Email</a></div><ul style="display: none;" id="1-sub-6">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Email.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Enum"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Enum" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Enum">Enum</a></div><ul style="display: none;" id="1-sub-7">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Enum.Drinker">Drinker</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Enum.Gender">Gender</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Enum.LookingFor">LookingFor</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Enum.Presence">Presence</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Enum.Smoker">Smoker</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Environment"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Environment" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Environment">Environment</a></div><ul style="display: none;" id="1-sub-8">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Environment.ObjectType">ObjectType</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.EscapeType">EscapeType</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand IdSpec"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand IdSpec" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.IdSpec">IdSpec</a></div><ul style="display: none;" id="1-sub-9">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.IdSpec.Field">Field</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.IdSpec.PersonId">PersonId</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand MediaItem"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand MediaItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.MediaItem">MediaItem</a></div><ul style="display: none;" id="1-sub-10">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.MediaItem.Field">Field</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.MediaItem.Type">Type</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Message"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Message" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Message">Message</a></div><ul style="display: none;" id="1-sub-11">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Message.Field">Field</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Message.Type">Type</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Name"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Name" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Name">Name</a></div><ul style="display: none;" id="1-sub-12">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Name.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand NavigationParameters"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand NavigationParameters" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.NavigationParameters">NavigationParameters</a></div><ul style="display: none;" id="1-sub-13">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.NavigationParameters.DestinationType">DestinationType</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.NavigationParameters.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Organization"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Organization" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Organization">Organization</a></div><ul style="display: none;" id="1-sub-14">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Organization.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Permission">Permission</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Person"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Person" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Person">Person</a></div><ul style="display: none;" id="1-sub-15">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Person.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Phone"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Phone" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Phone">Phone</a></div><ul style="display: none;" id="1-sub-16">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Phone.Field">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand ResponseItem"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand ResponseItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.ResponseItem">ResponseItem</a></div><ul style="display: none;" id="1-sub-17">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.ResponseItem.Error">Error</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Url"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Url" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Url">Url</a></div><ul style="display: none;" id="1-sub-18">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.Url.Field">Field</a>
  </li>
</ul>
  </li>
</ul>
</li>
</ul>

 

     <!-- Until that's fixed, we include _all_classes.ezt instead. -->
     <!--    
<ul>
<li><a href="#opensocial">opensocial</a>
<ul>
  <li><a href="#opensocial.Activity">Activity</a>
<ul>
  <li><a href="#opensocial.Activity.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Address">Address</a>
<ul>
  <li><a href="#opensocial.Address.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.BodyType">BodyType</a>
<ul>
  <li><a href="#opensocial.BodyType.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Collection">Collection</a>
  </li>
  <li><a href="#opensocial.CreateActivityPriority">CreateActivityPriority</a>
  </li>
  <li><a href="#opensocial.DataRequest">DataRequest</a>
<ul>
  <li><a href="#opensocial.DataRequest.DataRequestFields">DataRequestFields</a>
  </li>
  <li><a href="#opensocial.DataRequest.FilterType">FilterType</a>
  </li>
  <li><a href="#opensocial.DataRequest.PeopleRequestFields">PeopleRequestFields</a>
  </li>
  <li><a href="#opensocial.DataRequest.SortOrder">SortOrder</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.DataResponse">DataResponse</a>
  </li>
  <li><a href="#opensocial.Email">Email</a>
<ul>
  <li><a href="#opensocial.Email.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Enum">Enum</a>
<ul>
  <li><a href="#opensocial.Enum.Drinker">Drinker</a>
  </li>
  <li><a href="#opensocial.Enum.Gender">Gender</a>
  </li>
  <li><a href="#opensocial.Enum.LookingFor">LookingFor</a>
  </li>
  <li><a href="#opensocial.Enum.Presence">Presence</a>
  </li>
  <li><a href="#opensocial.Enum.Smoker">Smoker</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Environment">Environment</a>
<ul>
  <li><a href="#opensocial.Environment.ObjectType">ObjectType</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.EscapeType">EscapeType</a>
  </li>
  <li><a href="#opensocial.IdSpec">IdSpec</a>
<ul>
  <li><a href="#opensocial.IdSpec.Field">Field</a>
  </li>
  <li><a href="#opensocial.IdSpec.PersonId">PersonId</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.MediaItem">MediaItem</a>
<ul>
  <li><a href="#opensocial.MediaItem.Field">Field</a>
  </li>
  <li><a href="#opensocial.MediaItem.Type">Type</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Message">Message</a>
<ul>
  <li><a href="#opensocial.Message.Field">Field</a>
  </li>
  <li><a href="#opensocial.Message.Type">Type</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Name">Name</a>
<ul>
  <li><a href="#opensocial.Name.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.NavigationParameters">NavigationParameters</a>
<ul>
  <li><a href="#opensocial.NavigationParameters.DestinationType">DestinationType</a>
  </li>
  <li><a href="#opensocial.NavigationParameters.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Organization">Organization</a>
<ul>
  <li><a href="#opensocial.Organization.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Permission">Permission</a>
  </li>
  <li><a href="#opensocial.Person">Person</a>
<ul>
  <li><a href="#opensocial.Person.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Phone">Phone</a>
<ul>
  <li><a href="#opensocial.Phone.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.ResponseItem">ResponseItem</a>
<ul>
  <li><a href="#opensocial.ResponseItem.Error">Error</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Url">Url</a>
<ul>
  <li><a href="#opensocial.Url.Field">Field</a>
  </li>
</ul>
  </li>
</ul>
</li>
</ul>

 -->

     <!-- The following line is obsolete because (a) we don't include _all_classes.ezt -->
     <!-- any more, and (b) the extra tag in _all_classes.ezt has been fixed anyway. -->
     <!--     </ul></li>  -->
          <li style="padding-top: 0pt; padding-bottom: 0pt;"> 
              <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand gadgets (core)"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand gadgets (core)" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#core">gadgets (core)</a></div><ul style="display: none;" id="1-sub-19">
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.Prefs">Prefs</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand io"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand io" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io">io</a></div><ul style="display: none;" id="1-sub-20">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.AuthorizationType">AuthorizationType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.ContentType">ContentType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.MethodType">MethodType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.ProxyUrlRequestParameters">ProxyUrlRequestParameters</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.io.RequestParameters">RequestParameters</a></li>
        </ul>
      </li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.json">json</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.util">util</a></li>
    </ul>


          </li>
          <li style="padding-top: 0pt; padding-bottom: 0pt;"> 
              <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand gadgets (feature-specific)"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand gadgets (feature-specific)" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#features">gadgets (feature-specific)</a></div><ul style="display: none;" id="1-sub-21">
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.MiniMessage">MiniMessage</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.Tab">Tab</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.TabSet">TabSet</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.flash">flash</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.pubsub">pubsub</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.rpc">rpc</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;"> <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand skins"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand skins" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.skins">skins</a></div><ul style="display: none;" id="1-sub-22">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.skins.Property">Property</a></li>
      </ul></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;"> <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand views"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand views" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.views">views</a></div><ul style="display: none;" id="1-sub-23">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.views.View">View</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.views.ViewType">ViewType</a></li>
      </ul></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/#gadgets.window">window</a></li>
    </ul>

          </li>
        </ul>
      </li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Previous Versions"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Previous Versions" class="tlw-control tlw-plus"></a><span class="tlw-title">Previous Versions</span></div><ul style="display: none;" id="1-sub-62">
        <li style="padding-top: 0pt; padding-bottom: 0pt;">
          <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Version 0.7"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Version 0.7" class="tlw-control tlw-plus"></a><span class="tlw-title">Version 0.7</span></div><ul style="display: none;" id="1-sub-63">
            <li><a href="http://code.google.com/apis/opensocial/docs/0.7/devguide.html">Developer's Guide</a></li>
            <li><a href="http://code.google.com/apis/opensocial/docs/0.7/spec.html">API Specification</a></li>
            <li style="padding-top: 0pt; padding-bottom: 0pt;">
              <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand API Reference"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand API Reference" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/">API Reference</a></div><ul style="display: none;" id="1-sub-24">
                


<li style="padding-top: 0pt; padding-bottom: 0pt;">
  <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand opensocial"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand opensocial" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.html">opensocial</a></div><ul style="display: none;" id="1-sub-25">
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Activity"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Activity" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.html">Activity</a></div><ul style="display: none;" id="1-sub-26">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.Field.html">Field</a></li>
        <li style="padding-top: 0pt; padding-bottom: 0pt;">
          <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand MediaItem"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand MediaItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.MediaItem.html">MediaItem</a></div><ul style="display: none;" id="1-sub-27">
            <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.MediaItem.Field.html">Field</a></li>
            <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Activity.MediaItem.Type.html">Type</a></li>
          </ul>
        </li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Address"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Address" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Address.html">Address</a></div><ul style="display: none;" id="1-sub-28">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Address.Field.html">Field</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand BodyType"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand BodyType" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.BodyType.html">BodyType</a></div><ul style="display: none;" id="1-sub-29">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.BodyType.Field.html">Field</a></li>
      </ul>
    </li>
    <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Collection.html">Collection</a></li>
    <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.CreateActivityPriority.html">CreateActivityPriority</a></li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand DataRequest"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand DataRequest" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.html">DataRequest</a></div><ul style="display: none;" id="1-sub-30">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.FilterType.html">FilterType</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.Group.html">Group</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.PeopleRequestFields.html">PeopleRequestFields</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.PersonId.html">PersonId</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataRequest.SortOrder.html">SortOrder</a></li>
      </ul>
    </li>
    <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.DataResponse.html">DataResponse</a></li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Email"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Email" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Email.html">Email</a></div><ul style="display: none;" id="1-sub-31">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Email.Field.html">Field</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Enum"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Enum" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Enum.html">Enum</a></div><ul style="display: none;" id="1-sub-32">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Enum.Drinker.html">Drinker</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Enum.Gender.html">Gender</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Enum.Smoker.html">Smoker</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Environment"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Environment" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Environment.html">Environment</a></div><ul style="display: none;" id="1-sub-33">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Environment.ObjectType.html">ObjectType</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Message"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Message" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Message.html">Message</a></div><ul style="display: none;" id="1-sub-34">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Message.Field.html">Field</a></li>
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Message.Type.html">Type</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Name"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Name" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Name.html">Name</a></div><ul style="display: none;" id="1-sub-35">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Name.Field.html">Field</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Organization"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Organization" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Organization.html">Organization</a></div><ul style="display: none;" id="1-sub-36">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Organization.Field.html">Field</a></li>
      </ul>
    </li>
    <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Permission.html">Permission</a></li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Person"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Person" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Person.html">Person</a></div><ul style="display: none;" id="1-sub-37">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Person.Field.html">Field</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Phone"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Phone" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Phone.html">Phone</a></div><ul style="display: none;" id="1-sub-38">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Phone.Field.html">Field</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand ResponseItem"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand ResponseItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.ResponseItem.html">ResponseItem</a></div><ul style="display: none;" id="1-sub-39">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.ResponseItem.Error.html">Error</a></li>
      </ul>
    </li>
    <li style="padding-top: 0pt; padding-bottom: 0pt;">
      <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Url"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Url" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Url.html">Url</a></div><ul style="display: none;" id="1-sub-40">
        <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.Url.Field.html">Field</a></li>
      </ul>
    </li>
  </ul>
</li>

                  <li style="padding-top: 0pt; padding-bottom: 0pt;">
    <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand gadgets (core)"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand gadgets (core)" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets_core.html">gadgets (core)</a></div><ul style="display: none;" id="1-sub-41">
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.Prefs.html">Prefs</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand io"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand io" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.io.html">io</a></div><ul style="display: none;" id="1-sub-42">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.io.AuthorizationType.html">AuthorizationType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.io.ContentType.html">ContentType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.io.MethodType.html">MethodType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.io.RequestParameters.html">RequestParameters</a></li>
        </ul>
      </li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.json.html">json</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.util.html">util</a></li>
    </ul>
  </li>

                  <li style="padding-top: 0pt; padding-bottom: 0pt;">
    <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand gadgets (feature-specific)"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand gadgets (feature-specific)" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets_feature.html">gadgets (feature-specific)</a></div><ul style="display: none;" id="1-sub-43">
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.MiniMessage.html">MiniMessage</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.Tab.html">Tab</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.TabSet.html">TabSet</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.flash.html">flash</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.rpc.html">rpc</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand views"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand views" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.views.html">views</a></div><ul style="display: none;" id="1-sub-44">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.views.View.html">View</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.views.ViewType.html">ViewType</a></li>
        </ul>
      </li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand skins"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand skins" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.skins.html">skins</a></div><ul style="display: none;" id="1-sub-45">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.skins.Property.html">Property</a></li>
        </ul>
      </li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.7/reference/gadgets.window.html">window</a></li>
    </ul>
  </li>

              </ul>
            </li>
          </ul>
        </li>
        <li style="padding-top: 0pt; padding-bottom: 0pt;">
          <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Version 0.6"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Version 0.6" class="tlw-control tlw-plus"></a><span class="tlw-title">Version 0.6</span></div><ul style="display: none;" id="1-sub-64">
            <li><a href="http://code.google.com/apis/opensocial/docs/0.6/devguide.html">Developer's Guide</a></li>
            <li><a href="http://code.google.com/apis/opensocial/docs/0.6/spec.html">API Specification</a></li>
            <li style="padding-top: 0pt; padding-bottom: 0pt;">
              
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand API Reference"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand API Reference" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/">API Reference</a></div><ul style="display: none;" id="1-sub-46">    
 <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand opensocial"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand opensocial" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.html">opensocial</a></div><ul style="display: none;" id="1-sub-47">
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Activity"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Activity" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Activity.html">Activity</a></div><ul style="display: none;" id="1-sub-48">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Activity.Field.html">Field</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand MediaItem"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand MediaItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Activity.MediaItem.html">MediaItem</a></div><ul style="display: none;" id="1-sub-49">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Activity.MediaItem.Field.html">Field</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Activity.MediaItem.Type.html">Type</a>
  </li>
</ul>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Collection.html">Collection</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand ContentRequestParameters"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand ContentRequestParameters" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.ContentRequestParameters.html">ContentRequestParameters</a></div><ul style="display: none;" id="1-sub-50">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.ContentRequestParameters.AuthenticationType.html">AuthenticationType</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.ContentRequestParameters.ContentType.html">ContentType</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.ContentRequestParameters.MethodType.html">MethodType</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.CreateActivityPriority.html">CreateActivityPriority</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand DataRequest"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand DataRequest" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.html">DataRequest</a></div><ul style="display: none;" id="1-sub-51">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.ActivityRequestFields.html">ActivityRequestFields</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.FilterType.html">FilterType</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.Group.html">Group</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.PeopleRequestFields.html">PeopleRequestFields</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.PersonId.html">PersonId</a>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataRequest.SortOrder.html">SortOrder</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.DataResponse.html">DataResponse</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Environment"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Environment" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Environment.html">Environment</a></div><ul style="display: none;" id="1-sub-52">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Environment.ObjectType.html">ObjectType</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Permission.html">Permission</a>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Person"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Person" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Person.html">Person</a></div><ul style="display: none;" id="1-sub-53">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Person.Field.html">Field</a>
  </li>
</ul>
  </li>
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand ResponseItem"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand ResponseItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.ResponseItem.html">ResponseItem</a></div><ul style="display: none;" id="1-sub-54">
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.ResponseItem.Error.html">Error</a>
  </li>
</ul>
  </li>
  <li><a href="http://code.google.com/apis/opensocial/docs/0.6/reference/opensocial.Surface.html">Surface</a>
  </li>
</ul>
</li>

</ul>


            </li>
          </ul>
        </li>
          <li style="padding-top: 0pt; padding-bottom: 0pt;">
            <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Version 0.5"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Version 0.5" class="tlw-control tlw-plus"></a><span class="tlw-title">Version 0.5</span></div><ul style="display: none;" id="1-sub-65">
              <li><a href="http://code.google.com/apis/opensocial/docs/0.5/devguide.html">Developer's Guide</a></li>
              <li style="padding-top: 0pt; padding-bottom: 0pt;">
                
<div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand API Reference"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand API Reference" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/">API Reference</a></div><ul style="display: none;" id="1-sub-55">
  <li style="padding-top: 0pt; padding-bottom: 0pt;">
    <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand opensocial"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand opensocial" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.html">opensocial</a></div><ul style="display: none;" id="1-sub-56">
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Activity"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Activity" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Activity.html">Activity</a></div><ul style="display: none;" id="1-sub-57">
	        <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Activity.Field.html">Field</a></li>
	        <li style="padding-top: 0pt; padding-bottom: 0pt;">
	          <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand MediaItem"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand MediaItem" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Activity.MediaItem.html">MediaItem</a></div><ul style="display: none;" id="1-sub-58">
              <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Activity.MediaItem.Field.html">Field</a></li>
              <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Activity.MediaItem.Type.html">Type</a></li>
            </ul> 
          </li> <!-- end MediaItem -->
        </ul>
      </li> <!-- end Activity -->
      <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Collection.html">Collection</a></li>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.CreateActivityPriority.html">CreateActivityPriority</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand DataRequest"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand DataRequest" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.html">DataRequest</a></div><ul style="display: none;" id="1-sub-59">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.ActivityRequestFields.html">ActivityRequestFields</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.FilterType.html">FilterType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.Group.html">Group</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.PeopleRequestFields.html">PeopleRequestFields</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.PersonId.html">PersonId</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.ProfileDetailType.html">ProfileDetailType</a></li>
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataRequest.SortOrder.html">SortOrder</a></li>
        </ul> 
      </li> <!-- End DataRequest -->
      <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.DataResponse.html">DataResponse</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Person"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Person" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Person.html">Person</a></div><ul style="display: none;" id="1-sub-60">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Person.Field.html">Field</a></li>
        </ul>
      </li> <!-- end Person -->
      <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.ResponseItem.html">ResponseItem</a></li>
      <li style="padding-top: 0pt; padding-bottom: 0pt;">
        <div class="tlw-title tlw-branch"><a href="javascript:void(0)" class="tlw-control" title="Expand Stream"><img src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/cleardot.gif" alt="Expand Stream" class="tlw-control tlw-plus"></a><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Stream.html">Stream</a></div><ul style="display: none;" id="1-sub-61">
          <li><a href="http://code.google.com/apis/opensocial/docs/0.5/reference/opensocial.Stream.Field.html">Field</a></li>
        </ul>
      </li> <!-- end Stream -->
    </ul>
  </li> <!-- end opensocial -->
</ul>


              </li>
            </ul>
          </li>
        </ul>
      </li>
    </ul>
  </li>
  <li><h1 class="tlw-ignore">RESTful API</h1>
    <ul>
      <li><a href="http://code.google.com/apis/opensocial/docs/0.8/restfulspec.html">RESTful API Specification</a></li>
    </ul>
  </li>
  <li><h1 class="tlw-ignore">Other Resources</h1>
    <ul>
      <li><a href="http://code.google.com/apis/orkut/">Build apps for Orkut</a></li>
      <li><a href="http://code.google.com/apis/gadgets/docs/spec.html">Gadgets Specification</a></li>
    </ul>
  </li>
</ul>

      </div>
      
      <a name="gc-pagecontent"></a>   
      <div style="position: relative;" class="g-unit" id="gc-pagecontent"><ol class="cs-breadcrumbs"><li class="cs-crumb"><a href="http://code.google.com/apis/opensocial/docs/index.html" class="" title="Official OpenSocial documentation">Docs</a><span class="cs-crumbSpacer">&nbsp;&gt;&nbsp;</span></li><li class="cs-crumb"><a href="http://code.google.com/apis/opensocial/docs/0.8/reference/">API Reference (v0.8)</a></li></ol>
        <h1 class="page_title">OpenSocial API Reference (v0.8)</h1>


<p>
The OpenSocial JavaScript API includes two namespaces:
<code>opensocial.*</code> and
<code>gadgets.*</code>.
This page covers the <code>opensocial.*</code> namespace.
The <code>gadgets.*</code> namespace is covered in the
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets/">Gadgets API Reference</a>.
</p>

<h4>Contents</h4>

<ul>
   <li><span class="tlw-title"><a href="#types">Type Conventions</a></span></li>
</ul>

<ul>
<li><a href="#opensocial">opensocial</a>
<ul>
  <li><a href="#opensocial.Activity">Activity</a>
<ul>
  <li><a href="#opensocial.Activity.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Address">Address</a>
<ul>
  <li><a href="#opensocial.Address.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.BodyType">BodyType</a>
<ul>
  <li><a href="#opensocial.BodyType.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Collection">Collection</a>
  </li>
  <li><a href="#opensocial.CreateActivityPriority">CreateActivityPriority</a>
  </li>
  <li><a href="#opensocial.DataRequest">DataRequest</a>
<ul>
  <li><a href="#opensocial.DataRequest.DataRequestFields">DataRequestFields</a>
  </li>
  <li><a href="#opensocial.DataRequest.FilterType">FilterType</a>
  </li>
  <li><a href="#opensocial.DataRequest.PeopleRequestFields">PeopleRequestFields</a>
  </li>
  <li><a href="#opensocial.DataRequest.SortOrder">SortOrder</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.DataResponse">DataResponse</a>
  </li>
  <li><a href="#opensocial.Email">Email</a>
<ul>
  <li><a href="#opensocial.Email.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Enum">Enum</a>
<ul>
  <li><a href="#opensocial.Enum.Drinker">Drinker</a>
  </li>
  <li><a href="#opensocial.Enum.Gender">Gender</a>
  </li>
  <li><a href="#opensocial.Enum.LookingFor">LookingFor</a>
  </li>
  <li><a href="#opensocial.Enum.Presence">Presence</a>
  </li>
  <li><a href="#opensocial.Enum.Smoker">Smoker</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Environment">Environment</a>
<ul>
  <li><a href="#opensocial.Environment.ObjectType">ObjectType</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.EscapeType">EscapeType</a>
  </li>
  <li><a href="#opensocial.IdSpec">IdSpec</a>
<ul>
  <li><a href="#opensocial.IdSpec.Field">Field</a>
  </li>
  <li><a href="#opensocial.IdSpec.PersonId">PersonId</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.MediaItem">MediaItem</a>
<ul>
  <li><a href="#opensocial.MediaItem.Field">Field</a>
  </li>
  <li><a href="#opensocial.MediaItem.Type">Type</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Message">Message</a>
<ul>
  <li><a href="#opensocial.Message.Field">Field</a>
  </li>
  <li><a href="#opensocial.Message.Type">Type</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Name">Name</a>
<ul>
  <li><a href="#opensocial.Name.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.NavigationParameters">NavigationParameters</a>
<ul>
  <li><a href="#opensocial.NavigationParameters.DestinationType">DestinationType</a>
  </li>
  <li><a href="#opensocial.NavigationParameters.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Organization">Organization</a>
<ul>
  <li><a href="#opensocial.Organization.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Permission">Permission</a>
  </li>
  <li><a href="#opensocial.Person">Person</a>
<ul>
  <li><a href="#opensocial.Person.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Phone">Phone</a>
<ul>
  <li><a href="#opensocial.Phone.Field">Field</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.ResponseItem">ResponseItem</a>
<ul>
  <li><a href="#opensocial.ResponseItem.Error">Error</a>
  </li>
</ul>
  </li>
  <li><a href="#opensocial.Url">Url</a>
<ul>
  <li><a href="#opensocial.Url.Field">Field</a>
  </li>
</ul>
  </li>
</ul>
</li>
</ul>




<p class="backtotop"><a href="#top">Back to top</a></p>
<h1 id="types">Type Conventions</h1>

<p>
This document uses the following conventions for types:
</p>

<dl>
<dt> Array&lt;T&gt; <em>or</em> Array.&lt;T&gt; </dt>
  <dd>An Array filled with only objects of type T.
      This convention is similar to Java generics. </dd>
<dt> Map&lt;K, V&gt; <em>or</em> Map.&lt;K, V&gt; </dt>
  <dd>A JavaScript object with keys of type K
     that map to values of type V.
     Again, this convention is similar to Java generics.
     It's often used for <em>opt_params</em> variables.</dd>
<dt>static</dt>
  <dd>A type marked with <em>static class</em>
      has no public or private constructor.
      In other words, the type is a namespace,
      not a class that can be instantiated to create objects.
      The fields and functions in such a type
      are also marked as <em>static</em>.
      </dd>
<dt> Boolean </dt>
  <dd>A boolean value (not a <code>Boolean</code> object).</dd>
<dt> String </dt>
  <dd>A string value (not a <code>String</code> object).</dd>
</dl>


<p class="backtotop"><a href="#top">Back to top</a></p>









<h1 id="opensocial">Static Class opensocial</h1>

<!-- <i>Defined in <a href="opensocial.src.html">opensocial.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial_method_detail">DETAIL</a></p>


<p>
Namespace for top-level people functions.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>&lt;static&gt; 
             &nbsp;opensocial.Environment
          
<b> <a href="#opensocial.getEnvironment">getEnvironment</a></b>() </code> 
</dt>
<dd>Gets the current environment for this gadget.
</dd>

<dt><code>&lt;static&gt; 
             &nbsp;Boolean
          
<b> <a href="#opensocial.hasPermission">hasPermission</a></b>(permission) </code> 
</dt>
<dd>Returns true if the current gadget has access to the specified
permission.
</dd>

<dt><code>&lt;static&gt; 
             &nbsp;opensocial.Activity
          
<b> <a href="#opensocial.newActivity">newActivity</a></b>(params) </code> 
</dt>
<dd>Creates an activity object,
which represents an activity on the server.
</dd>

<dt><code>&lt;static&gt; 
             &nbsp;opensocial.DataRequest
          
<b> <a href="#opensocial.newDataRequest">newDataRequest</a></b>() </code> 
</dt>
<dd>Creates a data request object to use for sending and fetching data from the
server.
</dd>

<dt><code>&lt;static&gt; 
             &nbsp;opensocial.IdSpec
          
<b> <a href="#opensocial.newIdSpec">newIdSpec</a></b>(parameters) </code> 
</dt>
<dd>Creates an IdSpec object.
</dd>

<dt><code>&lt;static&gt; 
             &nbsp;opensocial.MediaItem
          
<b> <a href="#opensocial.newMediaItem">newMediaItem</a></b>(mimeType, url, opt_params) </code> 
</dt>
<dd>Creates a media item.
</dd>

<dt><code>&lt;static&gt; 
             &nbsp;opensocial.Message
          
<b> <a href="#opensocial.newMessage">newMessage</a></b>(body, opt_params) </code> 
</dt>
<dd>Creates a media item associated with an activity.
</dd>

<dt><code>&lt;static&gt; 
             &nbsp;opensocial.NavigationParameters
          
<b> <a href="#opensocial.newNavigationParameters">newNavigationParameters</a></b>(parameters) </code> 
</dt>
<dd>Creates a NavigationParameters object.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#opensocial.requestCreateActivity">requestCreateActivity</a></b>(activity, priority, opt_callback) </code> 
</dt>
<dd>Takes an activity and tries to create it,
without waiting for the operation to complete.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#opensocial.requestPermission">requestPermission</a></b>(permissions, reason, opt_callback) </code> 
</dt>
<dd>Requests the user to grant access to the specified permissions.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#opensocial.requestSendMessage">requestSendMessage</a></b>(recipients, message, opt_callback, opt_params) </code> 
</dt>
<dd>Requests the container to send a specific message to the specified users.
</dd>

<dt><code>&lt;static&gt; 
<b> <a href="#opensocial.requestShareApp">requestShareApp</a></b>(recipients, reason, opt_callback, opt_params) </code> 
</dt>
<dd>Requests the container to share this gadget with the specified users.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.getEnvironment"> </a> <h3>getEnvironment</h3>
        <pre>&lt;static&gt; opensocial.Environment <b>getEnvironment</b>()</pre> 
    <ul>
       Gets the current environment for this gadget. You can use the environment to
make queries such as what profile fields and surfaces are supported by this
container, what parameters were passed to the current gadget, and so on.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>opensocial.Environment</i>&nbsp;</code> The current <a href="#opensocial.Environment">environment</a>
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.hasPermission"> </a> <h3>hasPermission</h3>
        <pre>&lt;static&gt; Boolean <b>hasPermission</b>(permission)</pre> 
    <ul>
       Returns true if the current gadget has access to the specified
permission. If the gadget calls opensocial.requestPermission and permissions
are granted then this function must return true on all subsequent calls.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>opensocial.Permission</i>&nbsp;permission </code> - The <a href="#opensocial.Permission">permission</a> 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Boolean</i>&nbsp;</code> True if the gadget has access for the permission; false if it doesn't
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.newActivity"> </a> <h3>newActivity</h3>
        <pre>&lt;static&gt; opensocial.Activity <b>newActivity</b>(params)</pre> 
    <ul>
       Creates an activity object,
which represents an activity on the server.
<p>
<b>See also:</b>
<a href="#opensocial.requestCreateActivity">requestCreateActivity()</a>,
</p>

<p>It is only required to set one of TITLE_ID or TITLE. In addition, if you
are using any variables in your title or title template,
you must set TEMPLATE_PARAMS.</p>

<p>Other possible fields to set are: URL, MEDIA_ITEMS, BODY_ID, BODY,
EXTERNAL_ID, PRIORITY, STREAM_TITLE, STREAM_URL, STREAM_SOURCE_URL,
and STREAM_FAVICON_URL.</p>

<p>Containers are only required to use TITLE_ID or TITLE, and may choose to
ignore additional parameters.</p>

<p>See <a href="#opensocial.Activity.Field">Field</a> for
more details.</p>
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Map.&lt;opensocial.Activity.Field, Object&gt;</i>&nbsp;params </code> - Parameters defining the activity 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>opensocial.Activity</i>&nbsp;</code> The new
   <a href="#opensocial.Activity">activity</a> object
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.newDataRequest"> </a> <h3>newDataRequest</h3>
        <pre>&lt;static&gt; opensocial.DataRequest <b>newDataRequest</b>()</pre> 
    <ul>
       Creates a data request object to use for sending and fetching data from the
server.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>opensocial.DataRequest</i>&nbsp;</code> The
   <a href="#opensocial.DataRequest">request</a> object
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.newIdSpec"> </a> <h3>newIdSpec</h3>
        <pre>&lt;static&gt; opensocial.IdSpec <b>newIdSpec</b>(parameters)</pre> 
    <ul>
       Creates an IdSpec object.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Map.&lt;opensocial.IdSpec.Field, Object&gt;</i>&nbsp;parameters </code> - Parameters defining the id spec 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>opensocial.IdSpec</i>&nbsp;</code> The new
    <a href="#opensocial.IdSpec">IdSpec</a> object
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.newMediaItem"> </a> <h3>newMediaItem</h3>
        <pre>&lt;static&gt; opensocial.MediaItem <b>newMediaItem</b>(mimeType, url, opt_params)</pre> 
    <ul>
       Creates a media item.
Represents images, movies, and audio.
Used when creating activities on the server.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;mimeType </code> - <a href="#opensocial.MediaItem.Type">MIME type</a> of the
   media 
        </ul>
        <ul>
            <code><i>String</i>&nbsp;url </code> - Where the media can be found 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.MediaItem.Field, Object&gt;</i>&nbsp;opt_params </code> - Any other fields that should be set on the media item object;
   all of the defined
   <a href="#opensocial.MediaItem.Field">Field</a>s
   are supported 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>opensocial.MediaItem</i>&nbsp;</code> The new
   <a href="#opensocial.MediaItem">media item</a> object
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.newMessage"> </a> <h3>newMessage</h3>
        <pre>&lt;static&gt; opensocial.Message <b>newMessage</b>(body, opt_params)</pre> 
    <ul>
       Creates a media item associated with an activity.
Represents images, movies, and audio.
Used when creating activities on the server.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;body </code> - The main text of the message 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.Message.Field, Object&gt;</i>&nbsp;opt_params </code> - Any other fields that should be set on the message object;
   all of the defined
   <a href="#opensocial.Message.Field">Field</a>s
   are supported 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>opensocial.Message</i>&nbsp;</code> The new
   <a href="#opensocial.Message">message</a> object
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.newNavigationParameters"> </a> <h3>newNavigationParameters</h3>
        <pre>&lt;static&gt; opensocial.NavigationParameters <b>newNavigationParameters</b>(parameters)</pre> 
    <ul>
       Creates a NavigationParameters object.
<p>
<b>See also:</b>
<a href="#opensocial.requestShareApp">requestShareApp()</a>
</p>
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Map.&lt;opensocial.NavigationParameters.Field, Object&gt;</i>&nbsp;parameters </code> - Parameters defining the navigation 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>opensocial.NavigationParameters</i>&nbsp;</code> The new
    <a href="#opensocial.NavigationParameters">NavigationParameters</a> 
    object
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.requestCreateActivity"> </a> <h3>requestCreateActivity</h3>
        <pre>&lt;static&gt; <b>requestCreateActivity</b>(activity, priority, opt_callback)</pre> 
    <ul>
       Takes an activity and tries to create it,
without waiting for the operation to complete.
Optionally calls a function when the operation completes.
<p>
<b>See also:</b>
<a href="#opensocial.newActivity">newActivity()</a>
</p>

<p class="note">
<b>Note:</b>
If this is the first activity that has been created for the user and
the request is marked as HIGH priority then this call may open a user flow
and navigate away from your gadget.

</p><p>
This callback will either be called or the gadget will be
   reloaded from scratch. This function will be passed one parameter, an
   opensocial.ResponseItem. The error code will be set to reflect whether
   there were any problems with the request. If there was no error, the
   activity was created. If there was an error, you can use the response
   item's getErrorCode method to determine how to proceed. The data on the
   response item will not be set.
</p>

<p>
If the container does not support this method the callback will be called
with a opensocial.ResponseItem. The response item will have its error code
set to NOT_IMPLEMENTED.
</p>
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>opensocial.Activity</i>&nbsp;activity </code> - The <a href="#opensocial.Activity">
   activity</a> to create 
        </ul>
        <ul>
            <code><i>opensocial.CreateActivityPriority</i>&nbsp;priority </code> - The
   <a href="#opensocial.CreateActivityPriority">priority</a> for this
   request 
        </ul>
        <ul>
            <code><i>Function</i>&nbsp;opt_callback </code> - The function to call once the request has been
   processed. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.requestPermission"> </a> <h3>requestPermission</h3>
        <pre>&lt;static&gt; <b>requestPermission</b>(permissions, reason, opt_callback)</pre> 
    <ul>
       Requests the user to grant access to the specified permissions. If the
container does not support this method the callback will be called with a
opensocial.ResponseItem. The response item will have its error code set to
NOT_IMPLEMENTED.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Array.&lt;opensocial.Permission&gt;</i>&nbsp;permissions </code> - The <a href="#opensocial.Permission">permissions</a> to request
   from the viewer 
        </ul>
        <ul>
            <code><i>String</i>&nbsp;reason </code> - Displayed to the user as the reason why these
   permissions are needed 
        </ul>
        <ul>
            <code><i>Function</i>&nbsp;opt_callback </code> - The function to call once the request has been
   processed; either this callback will be called or the gadget will be
   reloaded from scratch. This function will be passed one parameter, an
   opensocial.ResponseItem. The error code will be set to reflect whether
   there were any problems with the request. If there was no error, all
   permissions were granted. If there was an error, you can use
   opensocial.hasPermission to check which permissions are still denied. The
   data on the response item will be set. It will be an array of the
   opensocial.Permissions that were granted. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.requestSendMessage"> </a> <h3>requestSendMessage</h3>
        <pre>&lt;static&gt; <b>requestSendMessage</b>(recipients, message, opt_callback, opt_params)</pre> 
    <ul>
       Requests the container to send a specific message to the specified users.

<p>
The callback function is passed one parameter, an
   opensocial.ResponseItem. The error code will be set to reflect whether
   there were any problems with the request. If there was no error, the
   message was sent. If there was an error, you can use the response item's
   getErrorCode method to determine how to proceed. The data on the response
   item will not be set.
</p>

<p>
If the container does not support this method
the callback will be called with an
opensocial.ResponseItem that has an error code of
NOT_IMPLEMENTED.
</p>
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Array.&lt;String&gt;, String</i>&nbsp;recipients </code> - An ID, array of IDs, or a
    group reference; the supported keys are VIEWER, OWNER, VIEWER_FRIENDS,
   OWNER_FRIENDS, or a single ID within one of those groups 
        </ul>
        <ul>
            <code><i>opensocial.Message</i>&nbsp;message </code> - The message to send to the specified
    users 
        </ul>
        <ul>
            <code><i>Function</i>&nbsp;opt_callback </code> - The function to call once the request has been
   processed; either this callback will be called or the gadget will be
   reloaded from scratch 
        </ul>
        <ul>
            <code><i>opensocial.NavigationParameters</i>&nbsp;opt_params </code> - The optional parameters
    indicating where to send a user when a request is made, or when a request is
    accepted; options are of type
    <a href="#opensocial.NavigationParameters.DestinationType">
    NavigationParameters.DestinationType</a> 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.requestShareApp"> </a> <h3>requestShareApp</h3>
        <pre>&lt;static&gt; <b>requestShareApp</b>(recipients, reason, opt_callback, opt_params)</pre> 
    <ul>
       Requests the container to share this gadget with the specified users.

<p>
The callback function is passed one parameter, an
   opensocial.ResponseItem. The error code will be set to reflect whether
   there were any problems with the request. If there was no error, the
   sharing request was sent. If there was an error, you can use the response
   item's getErrorCode method to determine how to proceed. The data on the
   response item will not be set.
</p>

<p>
If the
container does not support this method the callback will be called with a
opensocial.ResponseItem. The response item will have its error code set to
NOT_IMPLEMENTED.
</p>
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Array.&lt;String&gt;, String</i>&nbsp;recipients </code> - An ID, array of IDs, or a
    group reference; the supported keys are VIEWER, OWNER, VIEWER_FRIENDS,
   OWNER_FRIENDS, or a single ID within one of those groups 
        </ul>
        <ul>
            <code><i>opensocial.Message</i>&nbsp;reason </code> - The reason the user wants the gadget to
    share itself. This reason can be used by the container when prompting the
    user for permission to share the app. It may also be ignored. 
        </ul>
        <ul>
            <code><i>Function</i>&nbsp;opt_callback </code> - The function to call once the request has been
   processed; either this callback will be called or the gadget will be
   reloaded from scratch 
        </ul>
        <ul>
            <code><i>opensocial.NavigationParameters</i>&nbsp;opt_params </code> - The optional parameters
    indicating where to send a user when a request is made, or when a request is
    accepted; options are of type
    <a href="#opensocial.NavigationParameters.DestinationType">
    NavigationParameters.DestinationType</a> 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Activity">Class opensocial.Activity</h1>

<!-- <i>Defined in <a href="activity.src.html">activity.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Activity_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Activity_method_detail">DETAIL</a></p>


<p>
Representation of an activity.

</p><p>Activities are rendered with a title and an optional activity body.</p>

<p>You may set the title and body directly as strings when calling
opensocial.newActivity. However, it is usually beneficial to create activities using
Message Templates for the title and body.</p>

<p>Users will have many activities in their activity streams, and containers
will not show every activity that is visible to a user. To help display
large numbers of activities, containers will summarize a list of activities
from a given source to a single entry.</p>

<p>You can provide Activity Summaries to customize the text shown when
multiple activities are summarized. If no customization is provided, a
container may ignore your activities altogether or provide default text
such as "Bob changed his status message + 20 other events like this."</p>
<ul>
 <li>Activity Summaries will always summarize around a specific key in a
  key/value pair. This is so that the summary can say something concrete
  (this is clearer in the example below).</li>                               
 <li>Other variables will have synthetic "Count" variables created with
  the total number of items summarized.</li>
 <li>Message ID of the summary is the message ID of the main template + ":" +
  the data key</li>
</ul>

<p>Example summaries:
</p><pre>&lt;messagebundle&gt;
  &lt;msg name="LISTEN_TO_THIS_SONG:Artist"&gt;
    ${Subject.Count} of your friends have suggested listening to songs
    by ${Artist}!
  &lt;/msg&gt;
  &lt;msg name="LISTEN_TO_THIS_SONG:Song"&gt;
    ${Subject.Count} of your friends have suggested listening to ${Song}
  !&lt;/msg&gt;
  &lt;msg name="LISTEN_TO_THIS_SONG:Subject"&gt;
   ${Subject.DisplayName} has recommended ${Song.Count} songs to you.
  &lt;/msg&gt;
&lt;/messagebundle&gt;
</pre>

<p>
<b>See also:</b>
<a href="#opensocial.Message">opensocial.Message</a>,
<a href="#opensocial.newActivity">opensocial.newActivity()</a>,
<a href="#opensocial.requestCreateActivity">
opensocial.requestCreateActivity()</a></p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.Activity_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Activity.getField">getField</a></b>(key, opt_params) </code> 
</dt>
<dd>Gets the activity data that's associated with the specified key.
</dd>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Activity.getId">getId</a></b>() </code> 
</dt>
<dd>Gets an ID that can be permanently associated with this activity.
</dd>

<dt><code>
<b> <a href="#opensocial.Activity.setField">setField</a></b>(key, data) </code> 
</dt>
<dd>Sets data for this activity associated with the given key.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.Activity_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.Activity.getField"> </a> <h3>getField</h3>
        <pre>String <b>getField</b>(key, opt_params)</pre> 
    <ul>
       Gets the activity data that's associated with the specified key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to get data for;
  see the <a href="#opensocial.Activity.Field">Field</a> class
for possible values 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Activity.getId"> </a> <h3>getId</h3>
        <pre>String <b>getId</b>()</pre> 
    <ul>
       Gets an ID that can be permanently associated with this activity.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The ID
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Activity.setField"> </a> <h3>setField</h3>
        <pre><b>setField</b>(key, data)</pre> 
    <ul>
       Sets data for this activity associated with the given key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to set data for 
        </ul>
        <ul>
            <code><i>String</i>&nbsp;data </code> - The data to set 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Activity.Field">Static Class opensocial.Activity.Field</h1>

<!-- <i>Defined in <a href="activity.src.html">activity.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Activity.Field_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Activity.Field_field_detail">DETAIL</a></p>


<p>
All of the fields that activities can have.

</p><p>It is only required to set one of TITLE_ID or TITLE. In addition, if you
are using any variables in your title or title template,
you must set TEMPLATE_PARAMS.</p>

<p>Other possible fields to set are: URL, MEDIA_ITEMS, BODY_ID, BODY,
EXTERNAL_ID, PRIORITY, STREAM_TITLE, STREAM_URL, STREAM_SOURCE_URL,
and STREAM_FAVICON_URL.</p>

<p>Containers are only required to use TITLE_ID or TITLE, they may ignore
additional parameters.</p>

<p>
<b>See also:</b>
<a href="#opensocial.Activity.getField">opensocial.Activity.getField()</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Activity.Field_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.APP_ID">APP_ID</a></b></code>
</dt>
<dd>A string specifying the application that this activity is associated with.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.BODY">BODY</a></b></code>
</dt>
<dd><p>A string specifying an optional expanded version of an activity.


</p></dd><dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.BODY_ID">BODY_ID</a></b></code>
</dt>
<dd><p>A string specifying the body template message ID in the gadget spec.


</p></dd><dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.EXTERNAL_ID">EXTERNAL_ID</a></b></code>
</dt>
<dd>An optional string ID generated by the posting application.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.ID">ID</a></b></code>
</dt>
<dd>A string ID that is permanently associated with this activity.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.MEDIA_ITEMS">MEDIA_ITEMS</a></b></code>
</dt>
<dd>Any photos, videos, or images that should be associated
with the activity.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.POSTED_TIME">POSTED_TIME</a></b></code>
</dt>
<dd>A string specifying the time at which this activity took place
in milliseconds since the epoch.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.PRIORITY">PRIORITY</a></b></code>
</dt>
<dd>A number between 0 and 1 representing the relative priority of
this activity in relation to other activities from the same source
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.STREAM_FAVICON_URL">STREAM_FAVICON_URL</a></b></code>
</dt>
<dd>A string specifying the URL for the stream's favicon.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.STREAM_SOURCE_URL">STREAM_SOURCE_URL</a></b></code>
</dt>
<dd>A string specifying the stream's source URL.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.STREAM_TITLE">STREAM_TITLE</a></b></code>
</dt>
<dd>A string specifing the title of the stream.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.STREAM_URL">STREAM_URL</a></b></code>
</dt>
<dd>A string specifying the stream's URL.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.TEMPLATE_PARAMS">TEMPLATE_PARAMS</a></b></code>
</dt>
<dd><p>A map of custom key/value pairs associated with this activity.


</p></dd><dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.TITLE">TITLE</a></b></code>
</dt>
<dd><p>A string specifying the primary text of an activity.


</p></dd><dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.TITLE_ID">TITLE_ID</a></b></code>
</dt>
<dd><p>A string specifying the title template message ID in the gadget
  spec.


</p></dd><dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.URL">URL</a></b></code>
</dt>
<dd>A string specifying the
URL that represents this activity.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Activity.Field.USER_ID">USER_ID</a></b></code>
</dt>
<dd>The string ID of the user who this activity is for.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Activity.Field_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.APP_ID">
    <!-- -->
    </a> <h3>APP_ID</h3>
        <pre>&lt;static&gt; object <b>APP_ID</b></pre> 
    <ul>
       A string specifying the application that this activity is associated with.
This value can not be set.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.BODY">
    <!-- -->
    </a> <h3>BODY</h3>
        <pre>&lt;static&gt; object <b>BODY</b></pre> 
    <ul>
       <p>A string specifying an optional expanded version of an activity.</p>

<p>Bodies may only have the following HTML tags: &lt;b&gt; &lt;i&gt;,
&lt;a&gt;, &lt;span&gt;.
The container may ignore this formatting when rendering the activity.</p>
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.BODY_ID">
    <!-- -->
    </a> <h3>BODY_ID</h3>
        <pre>&lt;static&gt; object <b>BODY_ID</b></pre> 
    <ul>
       <p>A string specifying the body template message ID in the gadget spec.</p>

<p>The body is an optional expanded version of an activity.</p>

<p>Bodies may only have the following HTML tags: &lt;b&gt; &lt;i&gt;,
&lt;a&gt;, &lt;span&gt;.
The container may ignore this formatting when rendering the activity.</p>
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.EXTERNAL_ID">
    <!-- -->
    </a> <h3>EXTERNAL_ID</h3>
        <pre>&lt;static&gt; object <b>EXTERNAL_ID</b></pre> 
    <ul>
       An optional string ID generated by the posting application.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.ID">
    <!-- -->
    </a> <h3>ID</h3>
        <pre>&lt;static&gt; object <b>ID</b></pre> 
    <ul>
       A string ID that is permanently associated with this activity.
This value can not be set.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.MEDIA_ITEMS">
    <!-- -->
    </a> <h3>MEDIA_ITEMS</h3>
        <pre>&lt;static&gt; object <b>MEDIA_ITEMS</b></pre> 
    <ul>
       Any photos, videos, or images that should be associated
with the activity. Higher priority ones are higher in the list.
The data has type <code>Array&lt;
<a href="#opensocial.MediaItem">MediaItem</a>&gt;</code>.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.POSTED_TIME">
    <!-- -->
    </a> <h3>POSTED_TIME</h3>
        <pre>&lt;static&gt; object <b>POSTED_TIME</b></pre> 
    <ul>
       A string specifying the time at which this activity took place
in milliseconds since the epoch.
This value can not be set.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.PRIORITY">
    <!-- -->
    </a> <h3>PRIORITY</h3>
        <pre>&lt;static&gt; object <b>PRIORITY</b></pre> 
    <ul>
       A number between 0 and 1 representing the relative priority of
this activity in relation to other activities from the same source
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.STREAM_FAVICON_URL">
    <!-- -->
    </a> <h3>STREAM_FAVICON_URL</h3>
        <pre>&lt;static&gt; object <b>STREAM_FAVICON_URL</b></pre> 
    <ul>
       A string specifying the URL for the stream's favicon.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.STREAM_SOURCE_URL">
    <!-- -->
    </a> <h3>STREAM_SOURCE_URL</h3>
        <pre>&lt;static&gt; object <b>STREAM_SOURCE_URL</b></pre> 
    <ul>
       A string specifying the stream's source URL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.STREAM_TITLE">
    <!-- -->
    </a> <h3>STREAM_TITLE</h3>
        <pre>&lt;static&gt; object <b>STREAM_TITLE</b></pre> 
    <ul>
       A string specifing the title of the stream.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.STREAM_URL">
    <!-- -->
    </a> <h3>STREAM_URL</h3>
        <pre>&lt;static&gt; object <b>STREAM_URL</b></pre> 
    <ul>
       A string specifying the stream's URL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.TEMPLATE_PARAMS">
    <!-- -->
    </a> <h3>TEMPLATE_PARAMS</h3>
        <pre>&lt;static&gt; object <b>TEMPLATE_PARAMS</b></pre> 
    <ul>
       <p>A map of custom key/value pairs associated with this activity.
These will be used for evaluation in templates.</p>

<p>The data has type <code>Map&lt;String, Object&gt;</code>. The
object may be either a String or an opensocial.Person.</p>

<p>When passing in a person with key PersonKey, can use the following
replacement variables in the template:</p>
<ul>
 <li>PersonKey.DisplayName - Display name for the person</li>
 <li>PersonKey.ProfileUrl. URL of the person's profile</li>
 <li>PersonKey.Id -  The ID of the person</li>
 <li>PersonKey - Container may replace with DisplayName, but may also
    optionally link to the user.</li>
</ul>
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.TITLE">
    <!-- -->
    </a> <h3>TITLE</h3>
        <pre>&lt;static&gt; object <b>TITLE</b></pre> 
    <ul>
       <p>A string specifying the primary text of an activity.</p>

<p>Titles may only have the following HTML tags: &lt;b&gt; &lt;i&gt;,
&lt;a&gt;, &lt;span&gt;.
The container may ignore this formatting when rendering the activity.</p>
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.TITLE_ID">
    <!-- -->
    </a> <h3>TITLE_ID</h3>
        <pre>&lt;static&gt; object <b>TITLE_ID</b></pre> 
    <ul>
       <p>A string specifying the title template message ID in the gadget
  spec.</p>

<p>The title is the primary text of an activity.</p>

<p>Titles may only have the following HTML tags: &lt;b&gt; &lt;i&gt;,
&lt;a&gt;, &lt;span&gt;.
The container may ignore this formatting when rendering the activity.</p>
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.URL">
    <!-- -->
    </a> <h3>URL</h3>
        <pre>&lt;static&gt; object <b>URL</b></pre> 
    <ul>
       A string specifying the
URL that represents this activity.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Activity.Field.USER_ID">
    <!-- -->
    </a> <h3>USER_ID</h3>
        <pre>&lt;static&gt; object <b>USER_ID</b></pre> 
    <ul>
       The string ID of the user who this activity is for.
This value can not be set.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Address">Class opensocial.Address</h1>

<!-- <i>Defined in <a href="address.src.html">address.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Address_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Address_method_detail">DETAIL</a></p>


<p>
Base interface for all address objects.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.Address_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Address.getField">getField</a></b>(key, opt_params) </code> 
</dt>
<dd>Gets data for this body type that is associated with the specified key.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.Address_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.Address.getField"> </a> <h3>getField</h3>
        <pre>String <b>getField</b>(key, opt_params)</pre> 
    <ul>
       Gets data for this body type that is associated with the specified key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to get data for;
   keys are defined in <a href="#opensocial.Address.Field"><code>
   Address.Field</code></a> 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Address.Field">Static Class opensocial.Address.Field</h1>

<!-- <i>Defined in <a href="address.src.html">address.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Address.Field_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Address.Field_field_detail">DETAIL</a></p>


<p>
All of the fields that an address has. These are the supported keys for the
<a href="#opensocial.Address.getField">Address.getField()</a> method.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Address.Field_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Address.Field.COUNTRY">COUNTRY</a></b></code>
</dt>
<dd>The country, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Address.Field.EXTENDED_ADDRESS">EXTENDED_ADDRESS</a></b></code>
</dt>
<dd>The extended street address, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Address.Field.LATITUDE">LATITUDE</a></b></code>
</dt>
<dd>The latitude, specified as a number.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Address.Field.LOCALITY">LOCALITY</a></b></code>
</dt>
<dd>The locality, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Address.Field.LONGITUDE">LONGITUDE</a></b></code>
</dt>
<dd>The longitude, specified as a number.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Address.Field.PO_BOX">PO_BOX</a></b></code>
</dt>
<dd>The P.O.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Address.Field.POSTAL_CODE">POSTAL_CODE</a></b></code>
</dt>
<dd>The postal code, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Address.Field.REGION">REGION</a></b></code>
</dt>
<dd>The region, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Address.Field.STREET_ADDRESS">STREET_ADDRESS</a></b></code>
</dt>
<dd>The street address, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Address.Field.TYPE">TYPE</a></b></code>
</dt>
<dd>The address type or label, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Address.Field.UNSTRUCTURED_ADDRESS">UNSTRUCTURED_ADDRESS</a></b></code>
</dt>
<dd>If the container does not have structured addresses in its data store,
this field contains the unstructured address that the user entered,
specified as a string.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Address.Field_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Address.Field.COUNTRY">
    <!-- -->
    </a> <h3>COUNTRY</h3>
        <pre>&lt;static&gt; object <b>COUNTRY</b></pre> 
    <ul>
       The country, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Address.Field.EXTENDED_ADDRESS">
    <!-- -->
    </a> <h3>EXTENDED_ADDRESS</h3>
        <pre>&lt;static&gt; object <b>EXTENDED_ADDRESS</b></pre> 
    <ul>
       The extended street address, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Address.Field.LATITUDE">
    <!-- -->
    </a> <h3>LATITUDE</h3>
        <pre>&lt;static&gt; object <b>LATITUDE</b></pre> 
    <ul>
       The latitude, specified as a number.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Address.Field.LOCALITY">
    <!-- -->
    </a> <h3>LOCALITY</h3>
        <pre>&lt;static&gt; object <b>LOCALITY</b></pre> 
    <ul>
       The locality, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Address.Field.LONGITUDE">
    <!-- -->
    </a> <h3>LONGITUDE</h3>
        <pre>&lt;static&gt; object <b>LONGITUDE</b></pre> 
    <ul>
       The longitude, specified as a number.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Address.Field.PO_BOX">
    <!-- -->
    </a> <h3>PO_BOX</h3>
        <pre>&lt;static&gt; object <b>PO_BOX</b></pre> 
    <ul>
       The P.O. box of the address, if there is one; specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Address.Field.POSTAL_CODE">
    <!-- -->
    </a> <h3>POSTAL_CODE</h3>
        <pre>&lt;static&gt; object <b>POSTAL_CODE</b></pre> 
    <ul>
       The postal code, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Address.Field.REGION">
    <!-- -->
    </a> <h3>REGION</h3>
        <pre>&lt;static&gt; object <b>REGION</b></pre> 
    <ul>
       The region, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Address.Field.STREET_ADDRESS">
    <!-- -->
    </a> <h3>STREET_ADDRESS</h3>
        <pre>&lt;static&gt; object <b>STREET_ADDRESS</b></pre> 
    <ul>
       The street address, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Address.Field.TYPE">
    <!-- -->
    </a> <h3>TYPE</h3>
        <pre>&lt;static&gt; object <b>TYPE</b></pre> 
    <ul>
       The address type or label, specified as a string.
Examples: work, my favorite store, my house, etc.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Address.Field.UNSTRUCTURED_ADDRESS">
    <!-- -->
    </a> <h3>UNSTRUCTURED_ADDRESS</h3>
        <pre>&lt;static&gt; object <b>UNSTRUCTURED_ADDRESS</b></pre> 
    <ul>
       If the container does not have structured addresses in its data store,
this field contains the unstructured address that the user entered,
specified as a string. Use
opensocial.getEnvironment().supportsField to see which fields are
supported.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.BodyType">Class opensocial.BodyType</h1>

<!-- <i>Defined in <a href="bodyType.src.html">bodyType.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.BodyType_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.BodyType_method_detail">DETAIL</a></p>


<p>
Base interface for all body type objects.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.BodyType_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.BodyType.getField">getField</a></b>(key, opt_params) </code> 
</dt>
<dd>Gets data for this body type that is associated with the specified key.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.BodyType_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.BodyType.getField"> </a> <h3>getField</h3>
        <pre>String <b>getField</b>(key, opt_params)</pre> 
    <ul>
       Gets data for this body type that is associated with the specified key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to get data for;
   keys are defined in <a href="#opensocial.BodyType.Field"><code>
   BodyType.Field</code></a> 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.BodyType.Field">Static Class opensocial.BodyType.Field</h1>

<!-- <i>Defined in <a href="bodyType.src.html">bodyType.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.BodyType.Field_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.BodyType.Field_field_detail">DETAIL</a></p>


<p>
All of the fields that a body type has. These are the supported keys for the
<a href="#opensocial.BodyType.getField">BodyType.getField()</a>
method.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.BodyType.Field_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.BodyType.Field.BUILD">BUILD</a></b></code>
</dt>
<dd>The build of the person's body, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.BodyType.Field.EYE_COLOR">EYE_COLOR</a></b></code>
</dt>
<dd>The eye color of the person, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.BodyType.Field.HAIR_COLOR">HAIR_COLOR</a></b></code>
</dt>
<dd>The hair color of the person, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.BodyType.Field.HEIGHT">HEIGHT</a></b></code>
</dt>
<dd>The height of the person in meters, specified as a number.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.BodyType.Field.WEIGHT">WEIGHT</a></b></code>
</dt>
<dd>The weight of the person in kilograms, specified as a number.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.BodyType.Field_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.BodyType.Field.BUILD">
    <!-- -->
    </a> <h3>BUILD</h3>
        <pre>&lt;static&gt; object <b>BUILD</b></pre> 
    <ul>
       The build of the person's body, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.BodyType.Field.EYE_COLOR">
    <!-- -->
    </a> <h3>EYE_COLOR</h3>
        <pre>&lt;static&gt; object <b>EYE_COLOR</b></pre> 
    <ul>
       The eye color of the person, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.BodyType.Field.HAIR_COLOR">
    <!-- -->
    </a> <h3>HAIR_COLOR</h3>
        <pre>&lt;static&gt; object <b>HAIR_COLOR</b></pre> 
    <ul>
       The hair color of the person, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.BodyType.Field.HEIGHT">
    <!-- -->
    </a> <h3>HEIGHT</h3>
        <pre>&lt;static&gt; object <b>HEIGHT</b></pre> 
    <ul>
       The height of the person in meters, specified as a number.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.BodyType.Field.WEIGHT">
    <!-- -->
    </a> <h3>WEIGHT</h3>
        <pre>&lt;static&gt; object <b>WEIGHT</b></pre> 
    <ul>
       The weight of the person in kilograms, specified as a number.
Container support for this field is OPTIONAL.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Collection">Class opensocial.Collection</h1>

<!-- <i>Defined in <a href="collection.src.html">collection.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Collection_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Collection_method_detail">DETAIL</a></p>


<p>
Collection of multiple objects with useful accessors.
May also represent subset of a larger collection
(for example, page 1 of 10)
and contain information about the larger collection.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.Collection_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;Array.&lt;Object&gt;
          
<b> <a href="#opensocial.Collection.asArray">asArray</a></b>() </code> 
</dt>
<dd>Returns an array of all the objects in this collection.
</dd>

<dt><code>
<b> <a href="#opensocial.Collection.each">each</a></b>(fn) </code> 
</dt>
<dd>Executes the provided function once per member of the collection,
with each member in turn as the
parameter to the function.
</dd>

<dt><code>
             &nbsp;Object?
          
<b> <a href="#opensocial.Collection.getById">getById</a></b>(id) </code> 
</dt>
<dd>Finds the entry with the given ID value, or returns null if none is found.
</dd>

<dt><code>
             &nbsp;Number
          
<b> <a href="#opensocial.Collection.getOffset">getOffset</a></b>() </code> 
</dt>
<dd>Gets the offset of this collection within a larger result set.
</dd>

<dt><code>
             &nbsp;Number
          
<b> <a href="#opensocial.Collection.getTotalSize">getTotalSize</a></b>() </code> 
</dt>
<dd>Gets the total size of the larger result set
that this collection belongs to.
</dd>

<dt><code>
             &nbsp;Number
          
<b> <a href="#opensocial.Collection.size">size</a></b>() </code> 
</dt>
<dd>Gets the size of this collection,
which is equal to or less than the
total size of the result.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.Collection_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.Collection.asArray"> </a> <h3>asArray</h3>
        <pre>Array.&lt;Object&gt; <b>asArray</b>()</pre> 
    <ul>
       Returns an array of all the objects in this collection.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Array.&lt;Object&gt;</i>&nbsp;</code> The values in this collection
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Collection.each"> </a> <h3>each</h3>
        <pre><b>each</b>(fn)</pre> 
    <ul>
       Executes the provided function once per member of the collection,
with each member in turn as the
parameter to the function.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Function</i>&nbsp;fn </code> - The function to call with each collection entry 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Collection.getById"> </a> <h3>getById</h3>
        <pre>Object? <b>getById</b>(id)</pre> 
    <ul>
       Finds the entry with the given ID value, or returns null if none is found.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;id </code> - The ID to look for 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Object?</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Collection.getOffset"> </a> <h3>getOffset</h3>
        <pre>Number <b>getOffset</b>()</pre> 
    <ul>
       Gets the offset of this collection within a larger result set.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Number</i>&nbsp;</code> The offset into the total collection
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Collection.getTotalSize"> </a> <h3>getTotalSize</h3>
        <pre>Number <b>getTotalSize</b>()</pre> 
    <ul>
       Gets the total size of the larger result set
that this collection belongs to.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Number</i>&nbsp;</code> The total size of the result
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Collection.size"> </a> <h3>size</h3>
        <pre>Number <b>size</b>()</pre> 
    <ul>
       Gets the size of this collection,
which is equal to or less than the
total size of the result.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Number</i>&nbsp;</code> The size of this collection
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.CreateActivityPriority">Static Class opensocial.CreateActivityPriority</h1>

<!-- <i>Defined in <a href="opensocial.src.html">opensocial.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.CreateActivityPriority_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.CreateActivityPriority_field_detail">DETAIL</a></p>


<p>
The priorities a create activity request can have.
</p><p><b>See also:</b>
<a href="#opensocial.requestCreateActivity">
opensocial.requestCreateActivity()</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.CreateActivityPriority_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.CreateActivityPriority.HIGH">HIGH</a></b></code>
</dt>
<dd>If the activity is of high importance, it will be created even if this
requires asking the user for permission.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.CreateActivityPriority.LOW">LOW</a></b></code>
</dt>
<dd>If the activity is of low importance, it will not be created if the
user has not given permission for the current app to create activities.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.CreateActivityPriority_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.CreateActivityPriority.HIGH">
    <!-- -->
    </a> <h3>HIGH</h3>
        <pre>&lt;static&gt; object <b>HIGH</b></pre> 
    <ul>
       If the activity is of high importance, it will be created even if this
requires asking the user for permission. This may cause the container to
open a user flow which may navigate away from your gagdet.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.CreateActivityPriority.LOW">
    <!-- -->
    </a> <h3>LOW</h3>
        <pre>&lt;static&gt; object <b>LOW</b></pre> 
    <ul>
       If the activity is of low importance, it will not be created if the
user has not given permission for the current app to create activities.
With this priority, the requestCreateActivity call will never open a user
flow.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.DataRequest">Class opensocial.DataRequest</h1>

<!-- <i>Defined in <a href="datarequest.src.html">datarequest.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.DataRequest_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.DataRequest_method_detail">DETAIL</a></p>


<p>
</p><p>
Used to request social information from the container.
This includes data for friends, profiles, app data, and activities.
All apps that require access to people information
should send a DataRequest.
</p>

<p>
Here's an example of creating, initializing, sending, and handling
the results of a data request:
</p>

<pre>function requestMe() {
  var req = opensocial.newDataRequest();
  req.add(req.newFetchPersonRequest(
            opensocial.IdSpec.PersonId.VIEWER),
          "viewer");
  req.send(handleRequestMe);
};

function handleRequestMe(data) {
  var viewer = data.get("viewer");
  if (viewer.hadError()) {
    <em>//Handle error using viewer.getError()...</em>
    return;
  }

  <em>//No error. Do something with viewer.getData()...</em>
}
</pre>
<p>
<b>See also:</b>
<a href="#opensocial.newDataRequest"><code>
opensocial.newDataRequest()</code></a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.DataRequest_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
<b> <a href="#opensocial.DataRequest.add">add</a></b>(request, opt_key) </code> 
</dt>
<dd>Adds an item to fetch (get) or update (set) data from the server.
</dd>

<dt><code>
             &nbsp;Object
          
<b> <a href="#opensocial.DataRequest.newFetchActivitiesRequest">newFetchActivitiesRequest</a></b>(idSpec, opt_params) </code> 
</dt>
<dd>Creates an item to request an activity stream from the server.
</dd>

<dt><code>
             &nbsp;Object
          
<b> <a href="#opensocial.DataRequest.newFetchPeopleRequest">newFetchPeopleRequest</a></b>(idSpec, opt_params) </code> 
</dt>
<dd>Creates an item to request friends from the server.
</dd>

<dt><code>
             &nbsp;Object
          
<b> <a href="#opensocial.DataRequest.newFetchPersonAppDataRequest">newFetchPersonAppDataRequest</a></b>(idSpec, keys, opt_params) </code> 
</dt>
<dd>Creates an item to request app data for the given people.
</dd>

<dt><code>
             &nbsp;Object
          
<b> <a href="#opensocial.DataRequest.newFetchPersonRequest">newFetchPersonRequest</a></b>(id, opt_params) </code> 
</dt>
<dd>Creates an item to request a profile for the specified person ID.
</dd>

<dt><code>
             &nbsp;Object
          
<b> <a href="#opensocial.DataRequest.newRemovePersonAppDataRequest">newRemovePersonAppDataRequest</a></b>(id, keys) </code> 
</dt>
<dd>Deletes the given keys from the datastore for the given person.
</dd>

<dt><code>
             &nbsp;Object
          
<b> <a href="#opensocial.DataRequest.newUpdatePersonAppDataRequest">newUpdatePersonAppDataRequest</a></b>(id, key, value) </code> 
</dt>
<dd>Creates an item to request an update of an app field for the given person.
</dd>

<dt><code>
<b> <a href="#opensocial.DataRequest.send">send</a></b>(opt_callback) </code> 
</dt>
<dd>Sends a data request to the server in order to get a data response.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.DataRequest_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.DataRequest.add"> </a> <h3>add</h3>
        <pre><b>add</b>(request, opt_key)</pre> 
    <ul>
       Adds an item to fetch (get) or update (set) data from the server.
A single DataRequest object can have multiple items.
As a rule, each item is executed in the order it was added,
starting with the item that was added first.
However, items that can't collide might be executed in parallel.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Object</i>&nbsp;request </code> - Specifies which data to fetch or update 
        </ul>
        <ul>
            <code><i>String</i>&nbsp;opt_key </code> - A key to map the generated response data to 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.DataRequest.newFetchActivitiesRequest"> </a> <h3>newFetchActivitiesRequest</h3>
        <pre>Object <b>newFetchActivitiesRequest</b>(idSpec, opt_params)</pre> 
    <ul>
       Creates an item to request an activity stream from the server.

<p>
When processed, returns a Collection&lt;Activity&gt;.
</p>
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>opensocial.IdSpec</i>&nbsp;idSpec </code> - An IdSpec used to specify
   which people to fetch. See also <a href="#opensocial.IdSpec">IdSpec</a>. 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.ActivityRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional parameters
   to pass to the request; not currently used 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Object</i>&nbsp;</code> A request object
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.DataRequest.newFetchPeopleRequest"> </a> <h3>newFetchPeopleRequest</h3>
        <pre>Object <b>newFetchPeopleRequest</b>(idSpec, opt_params)</pre> 
    <ul>
       Creates an item to request friends from the server.
When processed, returns a <a href="#opensocial.Collection">Collection</a>
&lt;<a href="#opensocial.Person">Person</a>&gt; object.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>opensocial.IdSpec</i>&nbsp;idSpec </code> - An IdSpec used to specify
   which people to fetch. See also <a href="#opensocial.IdSpec">IdSpec</a>. 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.PeopleRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.PeopleRequestFields">params</a>
   to pass to the request 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Object</i>&nbsp;</code> A request object
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.DataRequest.newFetchPersonAppDataRequest"> </a> <h3>newFetchPersonAppDataRequest</h3>
        <pre>Object <b>newFetchPersonAppDataRequest</b>(idSpec, keys, opt_params)</pre> 
    <ul>
       Creates an item to request app data for the given people.
When processed, returns a Map&lt;
<a href="#opensocial.DataRequest.PersonId">PersonId</a>,
Map&lt;String,
Object&gt;&gt; object. All of the data values returned will be valid json.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>opensocial.IdSpec</i>&nbsp;idSpec </code> - An IdSpec used to specify
   which people to fetch. See also <a href="#opensocial.IdSpec">IdSpec</a>. 
        </ul>
        <ul>
            <code><i>Array.&lt;String&gt;, String</i>&nbsp;keys </code> - The keys you want data for; this
    can be an array of key names, a single key name, or "*" to mean
    "all keys" 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Object</i>&nbsp;</code> A request object
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.DataRequest.newFetchPersonRequest"> </a> <h3>newFetchPersonRequest</h3>
        <pre>Object <b>newFetchPersonRequest</b>(id, opt_params)</pre> 
    <ul>
       Creates an item to request a profile for the specified person ID.
When processed, returns a
<a href="#opensocial.Person"><code>Person</code></a> object.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;id </code> - The ID of the person to fetch; can be the standard
   <a href="#opensocial.DataRequest.PersonId">person ID</a>
   of VIEWER or OWNER 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.PeopleRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.PeopleRequestFields">parameters</a>
   to pass to the request; this request supports PROFILE_DETAILS 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Object</i>&nbsp;</code> A request object
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.DataRequest.newRemovePersonAppDataRequest"> </a> <h3>newRemovePersonAppDataRequest</h3>
        <pre>Object <b>newRemovePersonAppDataRequest</b>(id, keys)</pre> 
    <ul>
       Deletes the given keys from the datastore for the given person.
When processed, does not return any data.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;id </code> - The ID of the person to update; only the
    special <code>VIEWER</code> ID is currently allowed. 
        </ul>
        <ul>
            <code><i>Array.&lt;String&gt;, String</i>&nbsp;keys </code> - The keys you want to delete from
    the datastore; this can be an array of key names, a single key name,
    or "*" to mean "all keys" 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Object</i>&nbsp;</code> A request object
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.DataRequest.newUpdatePersonAppDataRequest"> </a> <h3>newUpdatePersonAppDataRequest</h3>
        <pre>Object <b>newUpdatePersonAppDataRequest</b>(id, key, value)</pre> 
    <ul>
       Creates an item to request an update of an app field for the given person.
When processed, does not return any data.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;id </code> - The ID of the person to update; only the
    special <code>VIEWER</code> ID is currently allowed. 
        </ul>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The name of the key. This may only contain alphanumeric
    (A-Za-z0-9) characters, underscore(_), dot(.) or dash(-). 
        </ul>
        <ul>
            <code><i>Object</i>&nbsp;value </code> - The value, must be valid json 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Object</i>&nbsp;</code> A request object
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.DataRequest.send"> </a> <h3>send</h3>
        <pre><b>send</b>(opt_callback)</pre> 
    <ul>
       Sends a data request to the server in order to get a data response.
Although the server may optimize these requests,
they will always be executed
as though they were serial.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>Function</i>&nbsp;opt_callback </code> - The function to call with the
  <a href="#opensocial.DataResponse">data response</a>
   generated by the server 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.DataRequest.DataRequestFields">Static Class opensocial.DataRequest.DataRequestFields</h1>

<!-- <i>Defined in <a href="datarequest.src.html">datarequest.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.DataRequest.DataRequestFields_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.DataRequest.DataRequestFields_field_detail">DETAIL</a></p>


<p>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.DataRequest.DataRequestFields_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.DataRequest.DataRequestFields.ESCAPE_TYPE">ESCAPE_TYPE</a></b></code>
</dt>
<dd>How to escape person data returned from the server; defaults to HTML_ESCAPE.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.DataRequest.DataRequestFields_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.DataRequest.DataRequestFields.ESCAPE_TYPE">
    <!-- -->
    </a> <h3>ESCAPE_TYPE</h3>
        <pre>&lt;static&gt; object <b>ESCAPE_TYPE</b></pre> 
    <ul>
       How to escape person data returned from the server; defaults to HTML_ESCAPE.
Possible values are defined by
<a href="#opensocial.EscapeType">EscapeType</a>.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.DataRequest.FilterType">Static Class opensocial.DataRequest.FilterType</h1>

<!-- <i>Defined in <a href="datarequest.src.html">datarequest.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.DataRequest.FilterType_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.DataRequest.FilterType_field_detail">DETAIL</a></p>


<p>
The filters available for limiting person requests.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.DataRequest.FilterType_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.DataRequest.FilterType.ALL">ALL</a></b></code>
</dt>
<dd>Retrieves all friends.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.DataRequest.FilterType.HAS_APP">HAS_APP</a></b></code>
</dt>
<dd>Retrieves all friends that use this application.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.DataRequest.FilterType.TOP_FRIENDS">TOP_FRIENDS</a></b></code>
</dt>
<dd>Retrieves only the user's top friends as defined by the container.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.DataRequest.FilterType_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.DataRequest.FilterType.ALL">
    <!-- -->
    </a> <h3>ALL</h3>
        <pre>&lt;static&gt; object <b>ALL</b></pre> 
    <ul>
       Retrieves all friends.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.DataRequest.FilterType.HAS_APP">
    <!-- -->
    </a> <h3>HAS_APP</h3>
        <pre>&lt;static&gt; object <b>HAS_APP</b></pre> 
    <ul>
       Retrieves all friends that use this application.

Note: Containers may define "use" in any manner they deem appropriate for
their functionality, and it is not expected that this field will have
the exact same semantics across containers.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.DataRequest.FilterType.TOP_FRIENDS">
    <!-- -->
    </a> <h3>TOP_FRIENDS</h3>
        <pre>&lt;static&gt; object <b>TOP_FRIENDS</b></pre> 
    <ul>
       Retrieves only the user's top friends as defined by the container.
Container support for this filter type is OPTIONAL.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.DataRequest.PeopleRequestFields">Static Class opensocial.DataRequest.PeopleRequestFields</h1>

<!-- <i>Defined in <a href="datarequest.src.html">datarequest.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.DataRequest.PeopleRequestFields_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.DataRequest.PeopleRequestFields_field_detail">DETAIL</a></p>


<p>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.DataRequest.PeopleRequestFields_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.DataRequest.PeopleRequestFields.FILTER">FILTER</a></b></code>
</dt>
<dd>How to filter the people objects; defaults to ALL.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.DataRequest.PeopleRequestFields.FILTER_OPTIONS">FILTER_OPTIONS</a></b></code>
</dt>
<dd>Additional options to be passed into the filter,
specified as a Map&lt;String, Object&gt;.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.DataRequest.PeopleRequestFields.FIRST">FIRST</a></b></code>
</dt>
<dd>When paginating, the index of the first item to fetch;
specified as a number.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.DataRequest.PeopleRequestFields.MAX">MAX</a></b></code>
</dt>
<dd>The maximum number of items to fetch,
specified as a number; defaults to 20.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.DataRequest.PeopleRequestFields.PROFILE_DETAILS">PROFILE_DETAILS</a></b></code>
</dt>
<dd>An array of
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/opensocial.Person.Field.html">
<code>opensocial.Person.Field</code></a>
specifying what profile data to fetch
for each of the person objects.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.DataRequest.PeopleRequestFields.SORT_ORDER">SORT_ORDER</a></b></code>
</dt>
<dd>A sort order for the people objects; defaults to TOP_FRIENDS.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.DataRequest.PeopleRequestFields_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.DataRequest.PeopleRequestFields.FILTER">
    <!-- -->
    </a> <h3>FILTER</h3>
        <pre>&lt;static&gt; object <b>FILTER</b></pre> 
    <ul>
       How to filter the people objects; defaults to ALL.
Possible values are defined by
<a href="#opensocial.DataRequest.FilterType">FilterType</a>.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.DataRequest.PeopleRequestFields.FILTER_OPTIONS">
    <!-- -->
    </a> <h3>FILTER_OPTIONS</h3>
        <pre>&lt;static&gt; object <b>FILTER_OPTIONS</b></pre> 
    <ul>
       Additional options to be passed into the filter,
specified as a Map&lt;String, Object&gt;.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.DataRequest.PeopleRequestFields.FIRST">
    <!-- -->
    </a> <h3>FIRST</h3>
        <pre>&lt;static&gt; object <b>FIRST</b></pre> 
    <ul>
       When paginating, the index of the first item to fetch;
specified as a number.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.DataRequest.PeopleRequestFields.MAX">
    <!-- -->
    </a> <h3>MAX</h3>
        <pre>&lt;static&gt; object <b>MAX</b></pre> 
    <ul>
       The maximum number of items to fetch,
specified as a number; defaults to 20. If set to a larger
number, a container may honor the request, or may limit the number to a
container-specified limit of at least 20.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.DataRequest.PeopleRequestFields.PROFILE_DETAILS">
    <!-- -->
    </a> <h3>PROFILE_DETAILS</h3>
        <pre>&lt;static&gt; object <b>PROFILE_DETAILS</b></pre> 
    <ul>
       An array of
<a href="#opensocial.Person.Field">
<code>opensocial.Person.Field</code></a>
specifying what profile data to fetch
for each of the person objects. The server will always include
ID, NAME, and THUMBNAIL_URL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.DataRequest.PeopleRequestFields.SORT_ORDER">
    <!-- -->
    </a> <h3>SORT_ORDER</h3>
        <pre>&lt;static&gt; object <b>SORT_ORDER</b></pre> 
    <ul>
       A sort order for the people objects; defaults to TOP_FRIENDS.
Possible values are defined by
<a href="#opensocial.DataRequest.SortOrder">SortOrder</a>.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.DataRequest.SortOrder">Static Class opensocial.DataRequest.SortOrder</h1>

<!-- <i>Defined in <a href="datarequest.src.html">datarequest.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.DataRequest.SortOrder_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.DataRequest.SortOrder_field_detail">DETAIL</a></p>


<p>
The sort orders available for ordering person objects.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.DataRequest.SortOrder_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.DataRequest.SortOrder.NAME">NAME</a></b></code>
</dt>
<dd>When used will sort people alphabetically by the name field.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.DataRequest.SortOrder.TOP_FRIENDS">TOP_FRIENDS</a></b></code>
</dt>
<dd>When used will sort people by the container's definition of top friends.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.DataRequest.SortOrder_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.DataRequest.SortOrder.NAME">
    <!-- -->
    </a> <h3>NAME</h3>
        <pre>&lt;static&gt; object <b>NAME</b></pre> 
    <ul>
       When used will sort people alphabetically by the name field.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.DataRequest.SortOrder.TOP_FRIENDS">
    <!-- -->
    </a> <h3>TOP_FRIENDS</h3>
        <pre>&lt;static&gt; object <b>TOP_FRIENDS</b></pre> 
    <ul>
       When used will sort people by the container's definition of top friends.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.DataResponse">Class opensocial.DataResponse</h1>

<!-- <i>Defined in <a href="dataresponse.src.html">dataresponse.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.DataResponse_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.DataResponse_method_detail">DETAIL</a></p>


<p>
This object contains the requested server data mapped to the requested keys.

</p><p>
<b>See also:</b>
<a href="#opensocial.DataRequest">DataRequest</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.DataResponse_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;opensocial.ResponseItem
          
<b> <a href="#opensocial.DataResponse.get">get</a></b>(key) </code> 
</dt>
<dd>Gets the ResponseItem for the requested field.
</dd>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.DataResponse.getErrorMessage">getErrorMessage</a></b>() </code> 
</dt>
<dd>If the entire request had a batch level error, returns the error message.
</dd>

<dt><code>
             &nbsp;Boolean
          
<b> <a href="#opensocial.DataResponse.hadError">hadError</a></b>() </code> 
</dt>
<dd>Returns true if there was an error in fetching this data from the server.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.DataResponse_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.DataResponse.get"> </a> <h3>get</h3>
        <pre>opensocial.ResponseItem <b>get</b>(key)</pre> 
    <ul>
       Gets the ResponseItem for the requested field.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code>key </code> 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>opensocial.ResponseItem</i>&nbsp;</code> The requested
   <a href="#opensocial.ResponseItem">response</a> calculated by the
   server
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.DataResponse.getErrorMessage"> </a> <h3>getErrorMessage</h3>
        <pre>String <b>getErrorMessage</b>()</pre> 
    <ul>
       If the entire request had a batch level error, returns the error message.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> A human-readable description of the error that occurred.
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.DataResponse.hadError"> </a> <h3>hadError</h3>
        <pre>Boolean <b>hadError</b>()</pre> 
    <ul>
       Returns true if there was an error in fetching this data from the server.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Boolean</i>&nbsp;</code> True if there was an error; otherwise, false
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Email">Class opensocial.Email</h1>

<!-- <i>Defined in <a href="email.src.html">email.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Email_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Email_method_detail">DETAIL</a></p>


<p>
Base interface for all email objects.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.Email_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Email.getField">getField</a></b>(key, opt_params) </code> 
</dt>
<dd>Gets data for this body type that is associated with the specified key.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.Email_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.Email.getField"> </a> <h3>getField</h3>
        <pre>String <b>getField</b>(key, opt_params)</pre> 
    <ul>
       Gets data for this body type that is associated with the specified key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to get data for;
   keys are defined in <a href="#opensocial.Email.Field"><code>
   Email.Field</code></a> 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Email.Field">Static Class opensocial.Email.Field</h1>

<!-- <i>Defined in <a href="email.src.html">email.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Email.Field_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Email.Field_field_detail">DETAIL</a></p>


<p>
All of the fields that an email has. These are the supported keys for the
<a href="#opensocial.Email.getField">Email.getField()</a> method.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Email.Field_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Email.Field.ADDRESS">ADDRESS</a></b></code>
</dt>
<dd>The email address, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Email.Field.TYPE">TYPE</a></b></code>
</dt>
<dd>The email type or label, specified as a string.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Email.Field_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Email.Field.ADDRESS">
    <!-- -->
    </a> <h3>ADDRESS</h3>
        <pre>&lt;static&gt; object <b>ADDRESS</b></pre> 
    <ul>
       The email address, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Email.Field.TYPE">
    <!-- -->
    </a> <h3>TYPE</h3>
        <pre>&lt;static&gt; object <b>TYPE</b></pre> 
    <ul>
       The email type or label, specified as a string.
Examples: work, my favorite store, my house, etc.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Enum">Class opensocial.Enum</h1>

<!-- <i>Defined in <a href="enum.src.html">enum.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Enum_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Enum_method_detail">DETAIL</a></p>


<p>
Base interface for all enum objects.
This class allows containers to use constants for fields that are usually
have a common set of values.
There are two main ways to use this class.

</p><p>
If your gadget just wants to display how much of a smoker someone is,
it can simply use:
</p>

<pre>html = "This person smokes: " + person.getField('smoker').getValue();</pre>

<p>
This value field will be correctly set up by the container. This is a place
where the container can even localize the value for the gadget so that it
always shows the right thing.
</p>

<p>
If your gadget wants to have some logic around the smoker
field it can use:
</p>

<pre>if (person.getField('smoker').getKey() != "NO") { //gadget logic here }</pre>

<p class="note">
<b>Note:</b>
The key may be null if the person's smoker field cannot be coerced
into one of the standard enum types.
The value, on the other hand, is never null.
</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.Enum_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Enum.getDisplayValue">getDisplayValue</a></b>() </code> 
</dt>
<dd>The value of this enum.
</dd>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Enum.getKey">getKey</a></b>() </code> 
</dt>
<dd>Use this for logic within your gadget.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.Enum_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.Enum.getDisplayValue"> </a> <h3>getDisplayValue</h3>
        <pre>String <b>getDisplayValue</b>()</pre> 
    <ul>
       The value of this enum. This will be a user displayable string. If the
container supports localization, the string will be localized.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The enum's value.
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Enum.getKey"> </a> <h3>getKey</h3>
        <pre>String <b>getKey</b>()</pre> 
    <ul>
       Use this for logic within your gadget. If they key is null then the value
does not fit in the defined enums.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The enum's key. This should be one of the defined enums
    below.
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Enum.Drinker">Static Class opensocial.Enum.Drinker</h1>

<!-- <i>Defined in <a href="enum.src.html">enum.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Enum.Drinker_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Enum.Drinker_field_detail">DETAIL</a></p>


<p>
The enum keys used by the drinker field.
</p><p><b>See also:</b>
<a href="#opensocial.Person.Field">
opensocial.Person.Field.Drinker</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Enum.Drinker_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Drinker.HEAVILY">HEAVILY</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Drinker.NO">NO</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Drinker.OCCASIONALLY">OCCASIONALLY</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Drinker.QUIT">QUIT</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Drinker.QUITTING">QUITTING</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Drinker.REGULARLY">REGULARLY</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Drinker.SOCIALLY">SOCIALLY</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Drinker.YES">YES</a></b></code>
</dt>
<dd>
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Enum.Drinker_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Drinker.HEAVILY">
    <!-- -->
    </a> <h3>HEAVILY</h3>
        <pre>&lt;static&gt; object <b>HEAVILY</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Drinker.NO">
    <!-- -->
    </a> <h3>NO</h3>
        <pre>&lt;static&gt; object <b>NO</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Drinker.OCCASIONALLY">
    <!-- -->
    </a> <h3>OCCASIONALLY</h3>
        <pre>&lt;static&gt; object <b>OCCASIONALLY</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Drinker.QUIT">
    <!-- -->
    </a> <h3>QUIT</h3>
        <pre>&lt;static&gt; object <b>QUIT</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Drinker.QUITTING">
    <!-- -->
    </a> <h3>QUITTING</h3>
        <pre>&lt;static&gt; object <b>QUITTING</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Drinker.REGULARLY">
    <!-- -->
    </a> <h3>REGULARLY</h3>
        <pre>&lt;static&gt; object <b>REGULARLY</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Drinker.SOCIALLY">
    <!-- -->
    </a> <h3>SOCIALLY</h3>
        <pre>&lt;static&gt; object <b>SOCIALLY</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Drinker.YES">
    <!-- -->
    </a> <h3>YES</h3>
        <pre>&lt;static&gt; object <b>YES</b></pre> 
    <ul>
       
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Enum.Gender">Static Class opensocial.Enum.Gender</h1>

<!-- <i>Defined in <a href="enum.src.html">enum.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Enum.Gender_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Enum.Gender_field_detail">DETAIL</a></p>


<p>
The enum keys used by the gender field.
</p><p><b>See also:</b>
<a href="#opensocial.Person.Field">
opensocial.Person.Field.Gender</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Enum.Gender_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Gender.FEMALE">FEMALE</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Gender.MALE">MALE</a></b></code>
</dt>
<dd>
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Enum.Gender_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Gender.FEMALE">
    <!-- -->
    </a> <h3>FEMALE</h3>
        <pre>&lt;static&gt; object <b>FEMALE</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Gender.MALE">
    <!-- -->
    </a> <h3>MALE</h3>
        <pre>&lt;static&gt; object <b>MALE</b></pre> 
    <ul>
       
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Enum.LookingFor">Static Class opensocial.Enum.LookingFor</h1>

<!-- <i>Defined in <a href="enum.src.html">enum.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Enum.LookingFor_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Enum.LookingFor_field_detail">DETAIL</a></p>


<p>
The enum keys used by the lookingFor field.
</p><p><b>See also:</b>
<a href="#opensocial.Person.Field">
opensocial.Person.Field.LookingFor</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Enum.LookingFor_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.LookingFor.ACTIVITY_PARTNERS">ACTIVITY_PARTNERS</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.LookingFor.DATING">DATING</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.LookingFor.FRIENDS">FRIENDS</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.LookingFor.NETWORKING">NETWORKING</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.LookingFor.RANDOM">RANDOM</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.LookingFor.RELATIONSHIP">RELATIONSHIP</a></b></code>
</dt>
<dd>
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Enum.LookingFor_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Enum.LookingFor.ACTIVITY_PARTNERS">
    <!-- -->
    </a> <h3>ACTIVITY_PARTNERS</h3>
        <pre>&lt;static&gt; object <b>ACTIVITY_PARTNERS</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.LookingFor.DATING">
    <!-- -->
    </a> <h3>DATING</h3>
        <pre>&lt;static&gt; object <b>DATING</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.LookingFor.FRIENDS">
    <!-- -->
    </a> <h3>FRIENDS</h3>
        <pre>&lt;static&gt; object <b>FRIENDS</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.LookingFor.NETWORKING">
    <!-- -->
    </a> <h3>NETWORKING</h3>
        <pre>&lt;static&gt; object <b>NETWORKING</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.LookingFor.RANDOM">
    <!-- -->
    </a> <h3>RANDOM</h3>
        <pre>&lt;static&gt; object <b>RANDOM</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.LookingFor.RELATIONSHIP">
    <!-- -->
    </a> <h3>RELATIONSHIP</h3>
        <pre>&lt;static&gt; object <b>RELATIONSHIP</b></pre> 
    <ul>
       
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Enum.Presence">Static Class opensocial.Enum.Presence</h1>

<!-- <i>Defined in <a href="enum.src.html">enum.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Enum.Presence_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Enum.Presence_field_detail">DETAIL</a></p>


<p>
The enum keys used by the networkPresence field.
</p><p><b>See also:</b>
<a href="#opensocial.Person.Field">
opensocial.Person.Field.NetworkPresence</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Enum.Presence_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Presence.AWAY">AWAY</a></b></code>
</dt>
<dd>The entity or resource is temporarily away.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Presence.CHAT">CHAT</a></b></code>
</dt>
<dd>The entity or resource is actively interested in chatting.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Presence.DND">DND</a></b></code>
</dt>
<dd>The entity or resource is busy (dnd = "Do Not Disturb").
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Presence.OFFLINE">OFFLINE</a></b></code>
</dt>
<dd>The entity or resource is off line.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Presence.ONLINE">ONLINE</a></b></code>
</dt>
<dd>The entity or resource is on line.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Presence.XA">XA</a></b></code>
</dt>
<dd>The entity or resource is away for an extended period
(xa = "eXtended Away").
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Enum.Presence_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Presence.AWAY">
    <!-- -->
    </a> <h3>AWAY</h3>
        <pre>&lt;static&gt; object <b>AWAY</b></pre> 
    <ul>
       The entity or resource is temporarily away.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Presence.CHAT">
    <!-- -->
    </a> <h3>CHAT</h3>
        <pre>&lt;static&gt; object <b>CHAT</b></pre> 
    <ul>
       The entity or resource is actively interested in chatting.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Presence.DND">
    <!-- -->
    </a> <h3>DND</h3>
        <pre>&lt;static&gt; object <b>DND</b></pre> 
    <ul>
       The entity or resource is busy (dnd = "Do Not Disturb").
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Presence.OFFLINE">
    <!-- -->
    </a> <h3>OFFLINE</h3>
        <pre>&lt;static&gt; object <b>OFFLINE</b></pre> 
    <ul>
       The entity or resource is off line.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Presence.ONLINE">
    <!-- -->
    </a> <h3>ONLINE</h3>
        <pre>&lt;static&gt; object <b>ONLINE</b></pre> 
    <ul>
       The entity or resource is on line.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Presence.XA">
    <!-- -->
    </a> <h3>XA</h3>
        <pre>&lt;static&gt; object <b>XA</b></pre> 
    <ul>
       The entity or resource is away for an extended period
(xa = "eXtended Away").
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Enum.Smoker">Static Class opensocial.Enum.Smoker</h1>

<!-- <i>Defined in <a href="enum.src.html">enum.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Enum.Smoker_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Enum.Smoker_field_detail">DETAIL</a></p>


<p>
The enum keys used by the smoker field.
</p><p><b>See also:</b>
<a href="#opensocial.Person.Field">
opensocial.Person.Field.Smoker</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Enum.Smoker_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Smoker.HEAVILY">HEAVILY</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Smoker.NO">NO</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Smoker.OCCASIONALLY">OCCASIONALLY</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Smoker.QUIT">QUIT</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Smoker.QUITTING">QUITTING</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Smoker.REGULARLY">REGULARLY</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Smoker.SOCIALLY">SOCIALLY</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Enum.Smoker.YES">YES</a></b></code>
</dt>
<dd>
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Enum.Smoker_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Smoker.HEAVILY">
    <!-- -->
    </a> <h3>HEAVILY</h3>
        <pre>&lt;static&gt; object <b>HEAVILY</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Smoker.NO">
    <!-- -->
    </a> <h3>NO</h3>
        <pre>&lt;static&gt; object <b>NO</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Smoker.OCCASIONALLY">
    <!-- -->
    </a> <h3>OCCASIONALLY</h3>
        <pre>&lt;static&gt; object <b>OCCASIONALLY</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Smoker.QUIT">
    <!-- -->
    </a> <h3>QUIT</h3>
        <pre>&lt;static&gt; object <b>QUIT</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Smoker.QUITTING">
    <!-- -->
    </a> <h3>QUITTING</h3>
        <pre>&lt;static&gt; object <b>QUITTING</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Smoker.REGULARLY">
    <!-- -->
    </a> <h3>REGULARLY</h3>
        <pre>&lt;static&gt; object <b>REGULARLY</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Smoker.SOCIALLY">
    <!-- -->
    </a> <h3>SOCIALLY</h3>
        <pre>&lt;static&gt; object <b>SOCIALLY</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Enum.Smoker.YES">
    <!-- -->
    </a> <h3>YES</h3>
        <pre>&lt;static&gt; object <b>YES</b></pre> 
    <ul>
       
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Environment">Class opensocial.Environment</h1>

<!-- <i>Defined in <a href="environment.src.html">environment.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Environment_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Environment_method_detail">DETAIL</a></p>


<p>
Represents the current environment for a gadget.

</p><p>
<b>See also:</b>
<a href="#opensocial.getEnvironment">opensocial.getEnvironment()</a>,</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.Environment_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Environment.getDomain">getDomain</a></b>() </code> 
</dt>
<dd>Returns the current domain —
for example, "orkut.com" or "myspace.com".
</dd>

<dt><code>
             &nbsp;Boolean
          
<b> <a href="#opensocial.Environment.supportsField">supportsField</a></b>(objectType, fieldName) </code> 
</dt>
<dd>Returns true if the specified field is supported in this container on the
given object type.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.Environment_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.Environment.getDomain"> </a> <h3>getDomain</h3>
        <pre>String <b>getDomain</b>()</pre> 
    <ul>
       Returns the current domain —
for example, "orkut.com" or "myspace.com".
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The domain
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Environment.supportsField"> </a> <h3>supportsField</h3>
        <pre>Boolean <b>supportsField</b>(objectType, fieldName)</pre> 
    <ul>
       Returns true if the specified field is supported in this container on the
given object type.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>opensocial.Environment.ObjectType</i>&nbsp;objectType </code> - The <a href="#opensocial.Environment.ObjectType">object type</a>
   to check for the field 
        </ul>
        <ul>
            <code><i>String</i>&nbsp;fieldName </code> - The name of the field to check for 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Boolean</i>&nbsp;</code> True if the field is supported on the specified object type
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Environment.ObjectType">Static Class opensocial.Environment.ObjectType</h1>

<!-- <i>Defined in <a href="environment.src.html">environment.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Environment.ObjectType_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Environment.ObjectType_field_detail">DETAIL</a></p>


<p>
The types of objects in this container.

</p><p>
<b>See also:</b>
<a href="#opensocial.Environment.supportsField">
<code>Environment.supportsField()</code></a></p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Environment.ObjectType_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.ACTIVITY">ACTIVITY</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.ADDRESS">ADDRESS</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.BODY_TYPE">BODY_TYPE</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.EMAIL">EMAIL</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.FILTER_TYPE">FILTER_TYPE</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.MEDIA_ITEM">MEDIA_ITEM</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.MESSAGE">MESSAGE</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.MESSAGE_TYPE">MESSAGE_TYPE</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.NAME">NAME</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.ORGANIZATION">ORGANIZATION</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.PERSON">PERSON</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.PHONE">PHONE</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.SORT_ORDER">SORT_ORDER</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Environment.ObjectType.URL">URL</a></b></code>
</dt>
<dd>
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Environment.ObjectType_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.ACTIVITY">
    <!-- -->
    </a> <h3>ACTIVITY</h3>
        <pre>&lt;static&gt; object <b>ACTIVITY</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.ADDRESS">
    <!-- -->
    </a> <h3>ADDRESS</h3>
        <pre>&lt;static&gt; object <b>ADDRESS</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.BODY_TYPE">
    <!-- -->
    </a> <h3>BODY_TYPE</h3>
        <pre>&lt;static&gt; object <b>BODY_TYPE</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.EMAIL">
    <!-- -->
    </a> <h3>EMAIL</h3>
        <pre>&lt;static&gt; object <b>EMAIL</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.FILTER_TYPE">
    <!-- -->
    </a> <h3>FILTER_TYPE</h3>
        <pre>&lt;static&gt; object <b>FILTER_TYPE</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.MEDIA_ITEM">
    <!-- -->
    </a> <h3>MEDIA_ITEM</h3>
        <pre>&lt;static&gt; object <b>MEDIA_ITEM</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.MESSAGE">
    <!-- -->
    </a> <h3>MESSAGE</h3>
        <pre>&lt;static&gt; object <b>MESSAGE</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.MESSAGE_TYPE">
    <!-- -->
    </a> <h3>MESSAGE_TYPE</h3>
        <pre>&lt;static&gt; object <b>MESSAGE_TYPE</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.NAME">
    <!-- -->
    </a> <h3>NAME</h3>
        <pre>&lt;static&gt; object <b>NAME</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.ORGANIZATION">
    <!-- -->
    </a> <h3>ORGANIZATION</h3>
        <pre>&lt;static&gt; object <b>ORGANIZATION</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.PERSON">
    <!-- -->
    </a> <h3>PERSON</h3>
        <pre>&lt;static&gt; object <b>PERSON</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.PHONE">
    <!-- -->
    </a> <h3>PHONE</h3>
        <pre>&lt;static&gt; object <b>PHONE</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.SORT_ORDER">
    <!-- -->
    </a> <h3>SORT_ORDER</h3>
        <pre>&lt;static&gt; object <b>SORT_ORDER</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Environment.ObjectType.URL">
    <!-- -->
    </a> <h3>URL</h3>
        <pre>&lt;static&gt; object <b>URL</b></pre> 
    <ul>
       
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.EscapeType">Static Class opensocial.EscapeType</h1>

<!-- <i>Defined in <a href="opensocial.src.html">opensocial.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.EscapeType_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.EscapeType_field_detail">DETAIL</a></p>


<p>
The types of escaping that can be applied to person data or fields.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.EscapeType_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.EscapeType.HTML_ESCAPE">HTML_ESCAPE</a></b></code>
</dt>
<dd>When used will HTML-escape the data.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.EscapeType.NONE">NONE</a></b></code>
</dt>
<dd>When used will not escape the data.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.EscapeType_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.EscapeType.HTML_ESCAPE">
    <!-- -->
    </a> <h3>HTML_ESCAPE</h3>
        <pre>&lt;static&gt; object <b>HTML_ESCAPE</b></pre> 
    <ul>
       When used will HTML-escape the data.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.EscapeType.NONE">
    <!-- -->
    </a> <h3>NONE</h3>
        <pre>&lt;static&gt; object <b>NONE</b></pre> 
    <ul>
       When used will not escape the data.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.IdSpec">Class opensocial.IdSpec</h1>

<!-- <i>Defined in <a href="idspec.src.html">idspec.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.IdSpec_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.IdSpec_method_detail">DETAIL</a></p>


<p>
Base interface for all id spec objects.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.IdSpec_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.IdSpec.getField">getField</a></b>(key, opt_params) </code> 
</dt>
<dd>Gets the id spec's data that's associated with the specified key.
</dd>

<dt><code>
<b> <a href="#opensocial.IdSpec.setField">setField</a></b>(key, data) </code> 
</dt>
<dd>Sets data for this id spec associated with the given key.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.IdSpec_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.IdSpec.getField"> </a> <h3>getField</h3>
        <pre>String <b>getField</b>(key, opt_params)</pre> 
    <ul>
       Gets the id spec's data that's associated with the specified key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to get data for;
  see the <a href="#opensocial.IdSpec.Field">Field</a> class
for possible values 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.IdSpec.setField"> </a> <h3>setField</h3>
        <pre><b>setField</b>(key, data)</pre> 
    <ul>
       Sets data for this id spec associated with the given key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to set data for 
        </ul>
        <ul>
            <code><i>String</i>&nbsp;data </code> - The data to set 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.IdSpec.Field">Static Class opensocial.IdSpec.Field</h1>

<!-- <i>Defined in <a href="idspec.src.html">idspec.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.IdSpec.Field_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.IdSpec.Field_field_detail">DETAIL</a></p>


<p>
All of the fields that id specs can have.

</p><p>
<b>See also:</b>
<a href="#opensocial.IdSpec.getField">opensocial.IdSpec.getField()</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.IdSpec.Field_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.IdSpec.Field.GROUP_ID">GROUP_ID</a></b></code>
</dt>
<dd>A string representing the group id.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.IdSpec.Field.NETWORK_DISTANCE">NETWORK_DISTANCE</a></b></code>
</dt>
<dd>An optional numeric parameter, used to specify how many "hops"
are allowed between two people still considered part of the
same group.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.IdSpec.Field.USER_ID">USER_ID</a></b></code>
</dt>
<dd>A string or an array of strings representing the user id.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.IdSpec.Field_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.IdSpec.Field.GROUP_ID">
    <!-- -->
    </a> <h3>GROUP_ID</h3>
        <pre>&lt;static&gt; object <b>GROUP_ID</b></pre> 
    <ul>
       A string representing the group id.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.IdSpec.Field.NETWORK_DISTANCE">
    <!-- -->
    </a> <h3>NETWORK_DISTANCE</h3>
        <pre>&lt;static&gt; object <b>NETWORK_DISTANCE</b></pre> 
    <ul>
       An optional numeric parameter, used to specify how many "hops"
are allowed between two people still considered part of the
same group. This is 0 based, for example:

A value of 0 means that the people are the same person.
1 would mean that the people were friends. 
And 2 would mean that there was a friend of a friend relationship. 

Defaults to 1 (they are both friends or directly in the same group).

Not all containers will support networkDistances greater than 1.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.IdSpec.Field.USER_ID">
    <!-- -->
    </a> <h3>USER_ID</h3>
        <pre>&lt;static&gt; object <b>USER_ID</b></pre> 
    <ul>
       A string or an array of strings representing the user id.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.IdSpec.PersonId">Static Class opensocial.IdSpec.PersonId</h1>

<!-- <i>Defined in <a href="idspec.src.html">idspec.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.IdSpec.PersonId_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.IdSpec.PersonId_field_detail">DETAIL</a></p>


<p>
Constant person IDs available when fetching person information.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.IdSpec.PersonId_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.IdSpec.PersonId.OWNER">OWNER</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.IdSpec.PersonId.VIEWER">VIEWER</a></b></code>
</dt>
<dd>
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.IdSpec.PersonId_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.IdSpec.PersonId.OWNER">
    <!-- -->
    </a> <h3>OWNER</h3>
        <pre>&lt;static&gt; object <b>OWNER</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.IdSpec.PersonId.VIEWER">
    <!-- -->
    </a> <h3>VIEWER</h3>
        <pre>&lt;static&gt; object <b>VIEWER</b></pre> 
    <ul>
       
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.MediaItem">Class opensocial.MediaItem</h1>

<!-- <i>Defined in <a href="mediaitem.src.html">mediaitem.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.MediaItem_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.MediaItem_method_detail">DETAIL</a></p>


<p>
Represents images, movies, and audio.
Create a <code>MediaItem</code> object using the
<a href="#opensocial.newMediaItem">
opensocial.newMediaItem()</a> method.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.MediaItem_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.MediaItem.getField">getField</a></b>(key, opt_params) </code> 
</dt>
<dd>Gets the media item data that's associated with the specified key.
</dd>

<dt><code>
<b> <a href="#opensocial.MediaItem.setField">setField</a></b>(key, data) </code> 
</dt>
<dd>Sets data for this media item associated with the given key.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.MediaItem_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.MediaItem.getField"> </a> <h3>getField</h3>
        <pre>String <b>getField</b>(key, opt_params)</pre> 
    <ul>
       Gets the media item data that's associated with the specified key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to get data for; see the
  <a href="#opensocial.MediaItem.Field">Field</a> class
  for possible values 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.MediaItem.setField"> </a> <h3>setField</h3>
        <pre><b>setField</b>(key, data)</pre> 
    <ul>
       Sets data for this media item associated with the given key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to set data for 
        </ul>
        <ul>
            <code><i>String</i>&nbsp;data </code> - The data to set 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.MediaItem.Field">Static Class opensocial.MediaItem.Field</h1>

<!-- <i>Defined in <a href="mediaitem.src.html">mediaitem.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.MediaItem.Field_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.MediaItem.Field_field_detail">DETAIL</a></p>


<p>
All of the fields that media items have.

</p><p>
<b>See also:</b>
<a href="#opensocial.MediaItem.getField">
opensocial.MediaItem.getField()</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.MediaItem.Field_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.MediaItem.Field.MIME_TYPE">MIME_TYPE</a></b></code>
</dt>
<dd>The MIME type of media, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.MediaItem.Field.TYPE">TYPE</a></b></code>
</dt>
<dd>The type of media, specified as a
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/opensocial.MediaItem.Type.html">
<code>MediaItem.Type</code></a> object.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.MediaItem.Field.URL">URL</a></b></code>
</dt>
<dd>A string specifying the URL where the media can be found.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.MediaItem.Field_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.MediaItem.Field.MIME_TYPE">
    <!-- -->
    </a> <h3>MIME_TYPE</h3>
        <pre>&lt;static&gt; object <b>MIME_TYPE</b></pre> 
    <ul>
       The MIME type of media, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.MediaItem.Field.TYPE">
    <!-- -->
    </a> <h3>TYPE</h3>
        <pre>&lt;static&gt; object <b>TYPE</b></pre> 
    <ul>
       The type of media, specified as a
<a href="#opensocial.MediaItem.Type">
<code>MediaItem.Type</code></a> object.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.MediaItem.Field.URL">
    <!-- -->
    </a> <h3>URL</h3>
        <pre>&lt;static&gt; object <b>URL</b></pre> 
    <ul>
       A string specifying the URL where the media can be found.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.MediaItem.Type">Static Class opensocial.MediaItem.Type</h1>

<!-- <i>Defined in <a href="mediaitem.src.html">mediaitem.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.MediaItem.Type_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.MediaItem.Type_field_detail">DETAIL</a></p>


<p>
The possible types of media items.

</p><p>
<b>See also:</b>
<a href="#opensocial.MediaItem.Field">
opensocial.MediaItem.Field</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.MediaItem.Type_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.MediaItem.Type.AUDIO">AUDIO</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.MediaItem.Type.IMAGE">IMAGE</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.MediaItem.Type.VIDEO">VIDEO</a></b></code>
</dt>
<dd>
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.MediaItem.Type_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.MediaItem.Type.AUDIO">
    <!-- -->
    </a> <h3>AUDIO</h3>
        <pre>&lt;static&gt; object <b>AUDIO</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.MediaItem.Type.IMAGE">
    <!-- -->
    </a> <h3>IMAGE</h3>
        <pre>&lt;static&gt; object <b>IMAGE</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.MediaItem.Type.VIDEO">
    <!-- -->
    </a> <h3>VIDEO</h3>
        <pre>&lt;static&gt; object <b>VIDEO</b></pre> 
    <ul>
       
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Message">Class opensocial.Message</h1>

<!-- <i>Defined in <a href="message.src.html">message.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Message_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Message_method_detail">DETAIL</a></p>


<p>
Base interface for all message objects.
*
</p><p>
<b>See also:</b>
<a href="#opensocial.newMessage">opensocial.newMessage()</a>,
<a href="#opensocial.requestSendMessage">
opensocial.requestSendMessage()</a></p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.Message_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Message.getField">getField</a></b>(key, opt_params) </code> 
</dt>
<dd>Gets the message data that's associated with the specified key.
</dd>

<dt><code>
<b> <a href="#opensocial.Message.setField">setField</a></b>(key, data) </code> 
</dt>
<dd>Sets data for this message associated with the given key.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.Message_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.Message.getField"> </a> <h3>getField</h3>
        <pre>String <b>getField</b>(key, opt_params)</pre> 
    <ul>
       Gets the message data that's associated with the specified key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to get data for;
  see the <a href="#opensocial.Message.Field">Field</a> class
for possible values 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Message.setField"> </a> <h3>setField</h3>
        <pre><b>setField</b>(key, data)</pre> 
    <ul>
       Sets data for this message associated with the given key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to set data for 
        </ul>
        <ul>
            <code><i>String</i>&nbsp;data </code> - The data to set 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Message.Field">Static Class opensocial.Message.Field</h1>

<!-- <i>Defined in <a href="message.src.html">message.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Message.Field_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Message.Field_field_detail">DETAIL</a></p>


<p>
All of the fields that messages can have.

</p><p>
<b>See also:</b>
<a href="#opensocial.Message.getField">opensocial.Message.getField()</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Message.Field_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Message.Field.BODY">BODY</a></b></code>
</dt>
<dd>The main text of the message.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Message.Field.BODY_ID">BODY_ID</a></b></code>
</dt>
<dd>The main text of the message as a message template.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Message.Field.TITLE">TITLE</a></b></code>
</dt>
<dd>The title of the message.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Message.Field.TITLE_ID">TITLE_ID</a></b></code>
</dt>
<dd>The title of the message as a message template.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Message.Field.TYPE">TYPE</a></b></code>
</dt>
<dd>The title of the message, specified as an opensocial.Message.Type.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Message.Field_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Message.Field.BODY">
    <!-- -->
    </a> <h3>BODY</h3>
        <pre>&lt;static&gt; object <b>BODY</b></pre> 
    <ul>
       The main text of the message. HTML attributes are allowed and are
sanitized by the container.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Message.Field.BODY_ID">
    <!-- -->
    </a> <h3>BODY_ID</h3>
        <pre>&lt;static&gt; object <b>BODY_ID</b></pre> 
    <ul>
       The main text of the message as a message template. Specifies the
message ID to use in the gadget xml.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Message.Field.TITLE">
    <!-- -->
    </a> <h3>TITLE</h3>
        <pre>&lt;static&gt; object <b>TITLE</b></pre> 
    <ul>
       The title of the message. HTML attributes are allowed and are
sanitized by the container.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Message.Field.TITLE_ID">
    <!-- -->
    </a> <h3>TITLE_ID</h3>
        <pre>&lt;static&gt; object <b>TITLE_ID</b></pre> 
    <ul>
       The title of the message as a message template. Specifies the
message ID to use in the gadget xml.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Message.Field.TYPE">
    <!-- -->
    </a> <h3>TYPE</h3>
        <pre>&lt;static&gt; object <b>TYPE</b></pre> 
    <ul>
       The title of the message, specified as an opensocial.Message.Type.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Message.Type">Static Class opensocial.Message.Type</h1>

<!-- <i>Defined in <a href="message.src.html">message.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Message.Type_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Message.Type_field_detail">DETAIL</a></p>


<p>
The types of messages that can be sent.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Message.Type_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Message.Type.EMAIL">EMAIL</a></b></code>
</dt>
<dd>An email.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Message.Type.NOTIFICATION">NOTIFICATION</a></b></code>
</dt>
<dd>A short private message.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Message.Type.PRIVATE_MESSAGE">PRIVATE_MESSAGE</a></b></code>
</dt>
<dd>A message to a specific user that can be seen only by that user.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Message.Type.PUBLIC_MESSAGE">PUBLIC_MESSAGE</a></b></code>
</dt>
<dd>A message to a specific user that can be seen by more than that user.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Message.Type_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Message.Type.EMAIL">
    <!-- -->
    </a> <h3>EMAIL</h3>
        <pre>&lt;static&gt; object <b>EMAIL</b></pre> 
    <ul>
       An email.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Message.Type.NOTIFICATION">
    <!-- -->
    </a> <h3>NOTIFICATION</h3>
        <pre>&lt;static&gt; object <b>NOTIFICATION</b></pre> 
    <ul>
       A short private message.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Message.Type.PRIVATE_MESSAGE">
    <!-- -->
    </a> <h3>PRIVATE_MESSAGE</h3>
        <pre>&lt;static&gt; object <b>PRIVATE_MESSAGE</b></pre> 
    <ul>
       A message to a specific user that can be seen only by that user.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Message.Type.PUBLIC_MESSAGE">
    <!-- -->
    </a> <h3>PUBLIC_MESSAGE</h3>
        <pre>&lt;static&gt; object <b>PUBLIC_MESSAGE</b></pre> 
    <ul>
       A message to a specific user that can be seen by more than that user.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Name">Class opensocial.Name</h1>

<!-- <i>Defined in <a href="name.src.html">name.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Name_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Name_method_detail">DETAIL</a></p>


<p>
Base interface for all name objects.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.Name_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Name.getField">getField</a></b>(key, opt_params) </code> 
</dt>
<dd>Gets data for this name that is associated with the specified key.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.Name_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.Name.getField"> </a> <h3>getField</h3>
        <pre>String <b>getField</b>(key, opt_params)</pre> 
    <ul>
       Gets data for this name that is associated with the specified key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to get data for;
   keys are defined in <a href="#opensocial.Name.Field"><code>
   Name.Field</code></a> 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Name.Field">Static Class opensocial.Name.Field</h1>

<!-- <i>Defined in <a href="name.src.html">name.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Name.Field_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Name.Field_field_detail">DETAIL</a></p>


<p>
All of the fields that a name has. These are the supported keys for the
<a href="#opensocial.Name.getField">Name.getField()</a> method.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Name.Field_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Name.Field.ADDITIONAL_NAME">ADDITIONAL_NAME</a></b></code>
</dt>
<dd>The additional name, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Name.Field.FAMILY_NAME">FAMILY_NAME</a></b></code>
</dt>
<dd>The family name, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Name.Field.GIVEN_NAME">GIVEN_NAME</a></b></code>
</dt>
<dd>The given name, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Name.Field.HONORIFIC_PREFIX">HONORIFIC_PREFIX</a></b></code>
</dt>
<dd>The honorific prefix, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Name.Field.HONORIFIC_SUFFIX">HONORIFIC_SUFFIX</a></b></code>
</dt>
<dd>The honorific suffix, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Name.Field.UNSTRUCTURED">UNSTRUCTURED</a></b></code>
</dt>
<dd>The unstructured name, specified as a string.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Name.Field_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Name.Field.ADDITIONAL_NAME">
    <!-- -->
    </a> <h3>ADDITIONAL_NAME</h3>
        <pre>&lt;static&gt; object <b>ADDITIONAL_NAME</b></pre> 
    <ul>
       The additional name, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Name.Field.FAMILY_NAME">
    <!-- -->
    </a> <h3>FAMILY_NAME</h3>
        <pre>&lt;static&gt; object <b>FAMILY_NAME</b></pre> 
    <ul>
       The family name, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Name.Field.GIVEN_NAME">
    <!-- -->
    </a> <h3>GIVEN_NAME</h3>
        <pre>&lt;static&gt; object <b>GIVEN_NAME</b></pre> 
    <ul>
       The given name, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Name.Field.HONORIFIC_PREFIX">
    <!-- -->
    </a> <h3>HONORIFIC_PREFIX</h3>
        <pre>&lt;static&gt; object <b>HONORIFIC_PREFIX</b></pre> 
    <ul>
       The honorific prefix, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Name.Field.HONORIFIC_SUFFIX">
    <!-- -->
    </a> <h3>HONORIFIC_SUFFIX</h3>
        <pre>&lt;static&gt; object <b>HONORIFIC_SUFFIX</b></pre> 
    <ul>
       The honorific suffix, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Name.Field.UNSTRUCTURED">
    <!-- -->
    </a> <h3>UNSTRUCTURED</h3>
        <pre>&lt;static&gt; object <b>UNSTRUCTURED</b></pre> 
    <ul>
       The unstructured name, specified as a string.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.NavigationParameters">Class opensocial.NavigationParameters</h1>

<!-- <i>Defined in <a href="navigationparameters.src.html">navigationparameters.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.NavigationParameters_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.NavigationParameters_method_detail">DETAIL</a></p>


<p>
Parameters used by RequestShareApp to instruct the container on where to go
after the request is made.

 It could be used, for example, to specify where viewers get routed
 in one of two cases:
1) After a user gets a shareApp invitation or receives a message a gadget
    developer should be able to send that user to a context sensitive place.
2) After a viewer actually shares an app with someone else the gadget
    developer should be able to redirect the viewer to a context sensitive
    place.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.NavigationParameters_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.NavigationParameters.getField">getField</a></b>(key, opt_params) </code> 
</dt>
<dd>Gets the NavigationParameters' data that's associated with the specified key.
</dd>

<dt><code>
<b> <a href="#opensocial.NavigationParameters.setField">setField</a></b>(key, data) </code> 
</dt>
<dd>Sets data for this NavigationParameters associated with the given key.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.NavigationParameters_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.NavigationParameters.getField"> </a> <h3>getField</h3>
        <pre>String <b>getField</b>(key, opt_params)</pre> 
    <ul>
       Gets the NavigationParameters' data that's associated with the specified key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to get data for;
  see the <a href="#opensocial.NavigationParameters.Field">Field</a> class
for possible values 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.NavigationParameters.setField"> </a> <h3>setField</h3>
        <pre><b>setField</b>(key, data)</pre> 
    <ul>
       Sets data for this NavigationParameters associated with the given key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to set data for 
        </ul>
        <ul>
            <code><i>Object</i>&nbsp;data </code> - The data to set 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.NavigationParameters.DestinationType">Static Class opensocial.NavigationParameters.DestinationType</h1>

<!-- <i>Defined in <a href="navigationparameters.src.html">navigationparameters.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.NavigationParameters.DestinationType_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.NavigationParameters.DestinationType_field_detail">DETAIL</a></p>


<p>
The destinations available for navigation in
<a href="#opensocial.requestShareApp">requestShareApp</a>
and <a href="#opensocial.requestSendMessage">requestSendMessage</a>.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.NavigationParameters.DestinationType_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.NavigationParameters.DestinationType.RECIPIENT_DESTINATION">RECIPIENT_DESTINATION</a></b></code>
</dt>
<dd>
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.NavigationParameters.DestinationType.VIEWER_DESTINATION">VIEWER_DESTINATION</a></b></code>
</dt>
<dd>
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.NavigationParameters.DestinationType_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.NavigationParameters.DestinationType.RECIPIENT_DESTINATION">
    <!-- -->
    </a> <h3>RECIPIENT_DESTINATION</h3>
        <pre>&lt;static&gt; object <b>RECIPIENT_DESTINATION</b></pre> 
    <ul>
       
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.NavigationParameters.DestinationType.VIEWER_DESTINATION">
    <!-- -->
    </a> <h3>VIEWER_DESTINATION</h3>
        <pre>&lt;static&gt; object <b>VIEWER_DESTINATION</b></pre> 
    <ul>
       
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.NavigationParameters.Field">Static Class opensocial.NavigationParameters.Field</h1>

<!-- <i>Defined in <a href="navigationparameters.src.html">navigationparameters.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.NavigationParameters.Field_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.NavigationParameters.Field_field_detail">DETAIL</a></p>


<p>
All of the fields that NavigationParameters can have.

</p><p>
<b>See also:</b>
<a href="#opensocial.NavigationParameters.getField">
        opensocial.NavigationParameters.getField()</a>
</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.NavigationParameters.Field_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.NavigationParameters.Field.OWNER">OWNER</a></b></code>
</dt>
<dd>A string representing the owner id.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.NavigationParameters.Field.PARAMETERS">PARAMETERS</a></b></code>
</dt>
<dd>An optional list of parameters passed to the gadget once the new view,
with the new owner, has been loaded.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.NavigationParameters.Field.VIEW">VIEW</a></b></code>
</dt>
<dd>The <a href="http://code.google.com/apis/opensocial/docs/0.8/reference/gadgets.views.View.html">View</a> to navigate to.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.NavigationParameters.Field_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.NavigationParameters.Field.OWNER">
    <!-- -->
    </a> <h3>OWNER</h3>
        <pre>&lt;static&gt; object <b>OWNER</b></pre> 
    <ul>
       A string representing the owner id.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.NavigationParameters.Field.PARAMETERS">
    <!-- -->
    </a> <h3>PARAMETERS</h3>
        <pre>&lt;static&gt; object <b>PARAMETERS</b></pre> 
    <ul>
       An optional list of parameters passed to the gadget once the new view,
with the new owner, has been loaded.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.NavigationParameters.Field.VIEW">
    <!-- -->
    </a> <h3>VIEW</h3>
        <pre>&lt;static&gt; object <b>VIEW</b></pre> 
    <ul>
       The <a href="#gadgets.views.View">View</a> to navigate to.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Organization">Class opensocial.Organization</h1>

<!-- <i>Defined in <a href="organization.src.html">organization.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Organization_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Organization_method_detail">DETAIL</a></p>


<p>
Base interface for all organization objects.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.Organization_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Organization.getField">getField</a></b>(key, opt_params) </code> 
</dt>
<dd>Gets data for this body type that is associated with the specified key.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.Organization_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.Organization.getField"> </a> <h3>getField</h3>
        <pre>String <b>getField</b>(key, opt_params)</pre> 
    <ul>
       Gets data for this body type that is associated with the specified key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to get data for;
   keys are defined in <a href="#opensocial.Organization.Field"><code>
   Organization.Field</code></a> 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Organization.Field">Static Class opensocial.Organization.Field</h1>

<!-- <i>Defined in <a href="organization.src.html">organization.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Organization.Field_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Organization.Field_field_detail">DETAIL</a></p>


<p>
All of the fields that a organization has. These are the supported keys for
the <a href="#opensocial.Organization.getField">
Organization.getField()</a> method.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Organization.Field_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Organization.Field.ADDRESS">ADDRESS</a></b></code>
</dt>
<dd>The address of the organization, specified as an opensocial.Address.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Organization.Field.DESCRIPTION">DESCRIPTION</a></b></code>
</dt>
<dd>A description or notes about the person's work in the organization,
specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Organization.Field.END_DATE">END_DATE</a></b></code>
</dt>
<dd>The date the person stopped at the organization, specified as a Date.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Organization.Field.FIELD">FIELD</a></b></code>
</dt>
<dd>The field the organization is in, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Organization.Field.NAME">NAME</a></b></code>
</dt>
<dd>The name of the organization, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Organization.Field.SALARY">SALARY</a></b></code>
</dt>
<dd>The salary the person receieves from the organization, specified as a
string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Organization.Field.START_DATE">START_DATE</a></b></code>
</dt>
<dd>The date the person started at the organization, specified as a Date.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Organization.Field.SUB_FIELD">SUB_FIELD</a></b></code>
</dt>
<dd>The subfield the Organization is in, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Organization.Field.TITLE">TITLE</a></b></code>
</dt>
<dd>The title or role the person has in the organization, specified as a
string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Organization.Field.WEBPAGE">WEBPAGE</a></b></code>
</dt>
<dd>A webpage related to the organization, specified as a string.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Organization.Field_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Organization.Field.ADDRESS">
    <!-- -->
    </a> <h3>ADDRESS</h3>
        <pre>&lt;static&gt; object <b>ADDRESS</b></pre> 
    <ul>
       The address of the organization, specified as an opensocial.Address.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Organization.Field.DESCRIPTION">
    <!-- -->
    </a> <h3>DESCRIPTION</h3>
        <pre>&lt;static&gt; object <b>DESCRIPTION</b></pre> 
    <ul>
       A description or notes about the person's work in the organization,
specified as a string. This could be the courses taken by a student, or a
more detailed description about a Organization role.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Organization.Field.END_DATE">
    <!-- -->
    </a> <h3>END_DATE</h3>
        <pre>&lt;static&gt; object <b>END_DATE</b></pre> 
    <ul>
       The date the person stopped at the organization, specified as a Date.
A null date indicates that the person is still involved with the
organization.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Organization.Field.FIELD">
    <!-- -->
    </a> <h3>FIELD</h3>
        <pre>&lt;static&gt; object <b>FIELD</b></pre> 
    <ul>
       The field the organization is in, specified as a string. This could be the
degree pursued if the organization is a school.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Organization.Field.NAME">
    <!-- -->
    </a> <h3>NAME</h3>
        <pre>&lt;static&gt; object <b>NAME</b></pre> 
    <ul>
       The name of the organization, specified as a string.
For example, could be a school name or a job company. 
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Organization.Field.SALARY">
    <!-- -->
    </a> <h3>SALARY</h3>
        <pre>&lt;static&gt; object <b>SALARY</b></pre> 
    <ul>
       The salary the person receieves from the organization, specified as a
string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Organization.Field.START_DATE">
    <!-- -->
    </a> <h3>START_DATE</h3>
        <pre>&lt;static&gt; object <b>START_DATE</b></pre> 
    <ul>
       The date the person started at the organization, specified as a Date.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Organization.Field.SUB_FIELD">
    <!-- -->
    </a> <h3>SUB_FIELD</h3>
        <pre>&lt;static&gt; object <b>SUB_FIELD</b></pre> 
    <ul>
       The subfield the Organization is in, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Organization.Field.TITLE">
    <!-- -->
    </a> <h3>TITLE</h3>
        <pre>&lt;static&gt; object <b>TITLE</b></pre> 
    <ul>
       The title or role the person has in the organization, specified as a
string. This could be graduate student, or software engineer.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Organization.Field.WEBPAGE">
    <!-- -->
    </a> <h3>WEBPAGE</h3>
        <pre>&lt;static&gt; object <b>WEBPAGE</b></pre> 
    <ul>
       A webpage related to the organization, specified as a string.
Container support for this field is OPTIONAL.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Permission">Static Class opensocial.Permission</h1>

<!-- <i>Defined in <a href="opensocial.src.html">opensocial.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Permission_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Permission_field_detail">DETAIL</a></p>


<p>
The permissions an app can ask for.

</p><p>
<b>See also:</b>
<a href="#opensocial.hasPermission">
<code>opensocial.hasPermission()</code></a>,
<a href="#opensocial.requestPermission">
<code>opensocial.requestPermission()</code></a></p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Permission_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Permission.VIEWER">VIEWER</a></b></code>
</dt>
<dd>Access to the viewer person object
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Permission_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Permission.VIEWER">
    <!-- -->
    </a> <h3>VIEWER</h3>
        <pre>&lt;static&gt; object <b>VIEWER</b></pre> 
    <ul>
       Access to the viewer person object
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Person">Class opensocial.Person</h1>

<!-- <i>Defined in <a href="person.src.html">person.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Person_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Person_method_detail">DETAIL</a></p>


<p>
Base interface for all person objects.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.Person_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Person.getDisplayName">getDisplayName</a></b>() </code> 
</dt>
<dd>Gets a text display name for this person; guaranteed to return
a useful string.
</dd>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Person.getField">getField</a></b>(key, opt_params) </code> 
</dt>
<dd>Gets data for this person that is associated with the specified key.
</dd>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Person.getId">getId</a></b>() </code> 
</dt>
<dd>Gets an ID that can be permanently associated with this person.
</dd>

<dt><code>
             &nbsp;Boolean
          
<b> <a href="#opensocial.Person.isOwner">isOwner</a></b>() </code> 
</dt>
<dd>Returns true if this person object represents the owner of the current page.
</dd>

<dt><code>
             &nbsp;Boolean
          
<b> <a href="#opensocial.Person.isViewer">isViewer</a></b>() </code> 
</dt>
<dd>Returns true if this person object represents the currently logged in user.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.Person_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.Person.getDisplayName"> </a> <h3>getDisplayName</h3>
        <pre>String <b>getDisplayName</b>()</pre> 
    <ul>
       Gets a text display name for this person; guaranteed to return
a useful string.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The display name
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Person.getField"> </a> <h3>getField</h3>
        <pre>String <b>getField</b>(key, opt_params)</pre> 
    <ul>
       Gets data for this person that is associated with the specified key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to get data for;
   keys are defined in <a href="#opensocial.Person.Field"><code>
   Person.Field</code></a> 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Person.getId"> </a> <h3>getId</h3>
        <pre>String <b>getId</b>()</pre> 
    <ul>
       Gets an ID that can be permanently associated with this person.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The ID
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Person.isOwner"> </a> <h3>isOwner</h3>
        <pre>Boolean <b>isOwner</b>()</pre> 
    <ul>
       Returns true if this person object represents the owner of the current page.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Boolean</i>&nbsp;</code> True if this is the owner of the page;
  otherwise, false
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.Person.isViewer"> </a> <h3>isViewer</h3>
        <pre>Boolean <b>isViewer</b>()</pre> 
    <ul>
       Returns true if this person object represents the currently logged in user.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Boolean</i>&nbsp;</code> True if this is the currently logged in user;
  otherwise, false
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Person.Field">Static Class opensocial.Person.Field</h1>

<!-- <i>Defined in <a href="person.src.html">person.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Person.Field_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Person.Field_field_detail">DETAIL</a></p>


<p>
All of the fields that a person has. These are the supported keys for the
<a href="#opensocial.Person.getField">Person.getField()</a> method.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Person.Field_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.ABOUT_ME">ABOUT_ME</a></b></code>
</dt>
<dd>A general statement about the person, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.ACTIVITIES">ACTIVITIES</a></b></code>
</dt>
<dd>Person's favorite activities, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.ADDRESSES">ADDRESSES</a></b></code>
</dt>
<dd>Addresses associated with the person, specified as an Array of
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/opensocial.Address.html">Address</a>es.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.AGE">AGE</a></b></code>
</dt>
<dd>Person's age, specified as a number.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.BODY_TYPE">BODY_TYPE</a></b></code>
</dt>
<dd>Person's body characteristics, specified as an opensocial.BodyType.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.BOOKS">BOOKS</a></b></code>
</dt>
<dd>Person's favorite books, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.CARS">CARS</a></b></code>
</dt>
<dd>Person's favorite cars, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.CHILDREN">CHILDREN</a></b></code>
</dt>
<dd>Description of the person's children, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.CURRENT_LOCATION">CURRENT_LOCATION</a></b></code>
</dt>
<dd>Person's current location, specified as an
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/opensocial.Address.html">Address</a>.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.DATE_OF_BIRTH">DATE_OF_BIRTH</a></b></code>
</dt>
<dd>Person's date of birth, specified as a Date object.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.DRINKER">DRINKER</a></b></code>
</dt>
<dd>Person's drinking status, specified as an opensocial.Enum with the enum's
key referencing opensocial.Enum.Drinker.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.EMAILS">EMAILS</a></b></code>
</dt>
<dd>Emails associated with the person, specified as an Array of
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/opensocial.Email.html">Email</a>s.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.ETHNICITY">ETHNICITY</a></b></code>
</dt>
<dd>Person's ethnicity, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.FASHION">FASHION</a></b></code>
</dt>
<dd>Person's thoughts on fashion, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.FOOD">FOOD</a></b></code>
</dt>
<dd>Person's favorite food, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.GENDER">GENDER</a></b></code>
</dt>
<dd>Person's gender, specified as an opensocial.Enum with the enum's
key referencing opensocial.Enum.Gender.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.HAPPIEST_WHEN">HAPPIEST_WHEN</a></b></code>
</dt>
<dd>Describes when the person is happiest, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.HAS_APP">HAS_APP</a></b></code>
</dt>
<dd>A boolean indicating whether the person has used the current app.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.HEROES">HEROES</a></b></code>
</dt>
<dd>Person's favorite heroes, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.HUMOR">HUMOR</a></b></code>
</dt>
<dd>Person's thoughts on humor, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.ID">ID</a></b></code>
</dt>
<dd>A string ID that can be permanently associated with this person.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.INTERESTS">INTERESTS</a></b></code>
</dt>
<dd>Person's interests, hobbies or passions, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.JOB_INTERESTS">JOB_INTERESTS</a></b></code>
</dt>
<dd>Person's favorite jobs, or job interests and skills, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.JOBS">JOBS</a></b></code>
</dt>
<dd>Jobs the person has held, specified as an Array of
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/opensocial.Organization.html">Organization</a>s.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.LANGUAGES_SPOKEN">LANGUAGES_SPOKEN</a></b></code>
</dt>
<dd>List of the languages that the person speaks as ISO 639-1 codes,
specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.LIVING_ARRANGEMENT">LIVING_ARRANGEMENT</a></b></code>
</dt>
<dd>Description of the person's living arrangement, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.LOOKING_FOR">LOOKING_FOR</a></b></code>
</dt>
<dd>Person's statement about who or what they are looking for, or what they are
interested in meeting people for.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.MOVIES">MOVIES</a></b></code>
</dt>
<dd>Person's favorite movies, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.MUSIC">MUSIC</a></b></code>
</dt>
<dd>Person's favorite music, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.NAME">NAME</a></b></code>
</dt>
<dd>A opensocial.Name object containing the person's name.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.NETWORK_PRESENCE">NETWORK_PRESENCE</a></b></code>
</dt>
<dd>Person's current network status.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.NICKNAME">NICKNAME</a></b></code>
</dt>
<dd>A String representing the person's nickname.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.PETS">PETS</a></b></code>
</dt>
<dd>Description of the person's pets, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.PHONE_NUMBERS">PHONE_NUMBERS</a></b></code>
</dt>
<dd>Phone numbers associated with the person, specified as an Array of
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/opensocial.Phone.html">Phone</a>s.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.POLITICAL_VIEWS">POLITICAL_VIEWS</a></b></code>
</dt>
<dd>Person's political views, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.PROFILE_SONG">PROFILE_SONG</a></b></code>
</dt>
<dd>Person's profile song, specified as an opensocial.Url.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.PROFILE_URL">PROFILE_URL</a></b></code>
</dt>
<dd>Person's profile URL, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.PROFILE_VIDEO">PROFILE_VIDEO</a></b></code>
</dt>
<dd>Person's profile video, specified as an opensocial.Url.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.QUOTES">QUOTES</a></b></code>
</dt>
<dd>Person's favorite quotes, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.RELATIONSHIP_STATUS">RELATIONSHIP_STATUS</a></b></code>
</dt>
<dd>Person's relationship status, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.RELIGION">RELIGION</a></b></code>
</dt>
<dd>Person's relgion or religious views, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.ROMANCE">ROMANCE</a></b></code>
</dt>
<dd>Person's comments about romance, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.SCARED_OF">SCARED_OF</a></b></code>
</dt>
<dd>What the person is scared of, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.SCHOOLS">SCHOOLS</a></b></code>
</dt>
<dd>Schools the person has attended, specified as an Array of
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/opensocial.Organization.html">Organization</a>s.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.SEXUAL_ORIENTATION">SEXUAL_ORIENTATION</a></b></code>
</dt>
<dd>Person's sexual orientation, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.SMOKER">SMOKER</a></b></code>
</dt>
<dd>Person's smoking status, specified as an opensocial.Enum with the enum's
key referencing opensocial.Enum.Smoker.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.SPORTS">SPORTS</a></b></code>
</dt>
<dd>Person's favorite sports, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.STATUS">STATUS</a></b></code>
</dt>
<dd>Person's status, headline or shoutout, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.TAGS">TAGS</a></b></code>
</dt>
<dd>Arbitrary tags about the person, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.THUMBNAIL_URL">THUMBNAIL_URL</a></b></code>
</dt>
<dd>Person's photo thumbnail URL, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.TIME_ZONE">TIME_ZONE</a></b></code>
</dt>
<dd>Person's time zone, specified as the difference in minutes between
Greenwich Mean Time (GMT) and the user's local time.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.TURN_OFFS">TURN_OFFS</a></b></code>
</dt>
<dd>Person's turn offs, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.TURN_ONS">TURN_ONS</a></b></code>
</dt>
<dd>Person's turn ons, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.TV_SHOWS">TV_SHOWS</a></b></code>
</dt>
<dd>Person's favorite TV shows, specified as an Array of strings.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Person.Field.URLS">URLS</a></b></code>
</dt>
<dd>URLs related to the person, their webpages, or feeds.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Person.Field_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.ABOUT_ME">
    <!-- -->
    </a> <h3>ABOUT_ME</h3>
        <pre>&lt;static&gt; object <b>ABOUT_ME</b></pre> 
    <ul>
       A general statement about the person, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.ACTIVITIES">
    <!-- -->
    </a> <h3>ACTIVITIES</h3>
        <pre>&lt;static&gt; object <b>ACTIVITIES</b></pre> 
    <ul>
       Person's favorite activities, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.ADDRESSES">
    <!-- -->
    </a> <h3>ADDRESSES</h3>
        <pre>&lt;static&gt; object <b>ADDRESSES</b></pre> 
    <ul>
       Addresses associated with the person, specified as an Array of
<a href="#opensocial.Address">Address</a>es.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.AGE">
    <!-- -->
    </a> <h3>AGE</h3>
        <pre>&lt;static&gt; object <b>AGE</b></pre> 
    <ul>
       Person's age, specified as a number.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.BODY_TYPE">
    <!-- -->
    </a> <h3>BODY_TYPE</h3>
        <pre>&lt;static&gt; object <b>BODY_TYPE</b></pre> 
    <ul>
       Person's body characteristics, specified as an opensocial.BodyType.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.BOOKS">
    <!-- -->
    </a> <h3>BOOKS</h3>
        <pre>&lt;static&gt; object <b>BOOKS</b></pre> 
    <ul>
       Person's favorite books, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.CARS">
    <!-- -->
    </a> <h3>CARS</h3>
        <pre>&lt;static&gt; object <b>CARS</b></pre> 
    <ul>
       Person's favorite cars, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.CHILDREN">
    <!-- -->
    </a> <h3>CHILDREN</h3>
        <pre>&lt;static&gt; object <b>CHILDREN</b></pre> 
    <ul>
       Description of the person's children, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.CURRENT_LOCATION">
    <!-- -->
    </a> <h3>CURRENT_LOCATION</h3>
        <pre>&lt;static&gt; object <b>CURRENT_LOCATION</b></pre> 
    <ul>
       Person's current location, specified as an
<a href="#opensocial.Address">Address</a>.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.DATE_OF_BIRTH">
    <!-- -->
    </a> <h3>DATE_OF_BIRTH</h3>
        <pre>&lt;static&gt; object <b>DATE_OF_BIRTH</b></pre> 
    <ul>
       Person's date of birth, specified as a Date object.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.DRINKER">
    <!-- -->
    </a> <h3>DRINKER</h3>
        <pre>&lt;static&gt; object <b>DRINKER</b></pre> 
    <ul>
       Person's drinking status, specified as an opensocial.Enum with the enum's
key referencing opensocial.Enum.Drinker.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.EMAILS">
    <!-- -->
    </a> <h3>EMAILS</h3>
        <pre>&lt;static&gt; object <b>EMAILS</b></pre> 
    <ul>
       Emails associated with the person, specified as an Array of
<a href="#opensocial.Email">Email</a>s.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.ETHNICITY">
    <!-- -->
    </a> <h3>ETHNICITY</h3>
        <pre>&lt;static&gt; object <b>ETHNICITY</b></pre> 
    <ul>
       Person's ethnicity, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.FASHION">
    <!-- -->
    </a> <h3>FASHION</h3>
        <pre>&lt;static&gt; object <b>FASHION</b></pre> 
    <ul>
       Person's thoughts on fashion, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.FOOD">
    <!-- -->
    </a> <h3>FOOD</h3>
        <pre>&lt;static&gt; object <b>FOOD</b></pre> 
    <ul>
       Person's favorite food, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.GENDER">
    <!-- -->
    </a> <h3>GENDER</h3>
        <pre>&lt;static&gt; object <b>GENDER</b></pre> 
    <ul>
       Person's gender, specified as an opensocial.Enum with the enum's
key referencing opensocial.Enum.Gender.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.HAPPIEST_WHEN">
    <!-- -->
    </a> <h3>HAPPIEST_WHEN</h3>
        <pre>&lt;static&gt; object <b>HAPPIEST_WHEN</b></pre> 
    <ul>
       Describes when the person is happiest, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.HAS_APP">
    <!-- -->
    </a> <h3>HAS_APP</h3>
        <pre>&lt;static&gt; object <b>HAS_APP</b></pre> 
    <ul>
       A boolean indicating whether the person has used the current app.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.HEROES">
    <!-- -->
    </a> <h3>HEROES</h3>
        <pre>&lt;static&gt; object <b>HEROES</b></pre> 
    <ul>
       Person's favorite heroes, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.HUMOR">
    <!-- -->
    </a> <h3>HUMOR</h3>
        <pre>&lt;static&gt; object <b>HUMOR</b></pre> 
    <ul>
       Person's thoughts on humor, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.ID">
    <!-- -->
    </a> <h3>ID</h3>
        <pre>&lt;static&gt; object <b>ID</b></pre> 
    <ul>
       A string ID that can be permanently associated with this person.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.INTERESTS">
    <!-- -->
    </a> <h3>INTERESTS</h3>
        <pre>&lt;static&gt; object <b>INTERESTS</b></pre> 
    <ul>
       Person's interests, hobbies or passions, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.JOB_INTERESTS">
    <!-- -->
    </a> <h3>JOB_INTERESTS</h3>
        <pre>&lt;static&gt; object <b>JOB_INTERESTS</b></pre> 
    <ul>
       Person's favorite jobs, or job interests and skills, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.JOBS">
    <!-- -->
    </a> <h3>JOBS</h3>
        <pre>&lt;static&gt; object <b>JOBS</b></pre> 
    <ul>
       Jobs the person has held, specified as an Array of
<a href="#opensocial.Organization">Organization</a>s.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.LANGUAGES_SPOKEN">
    <!-- -->
    </a> <h3>LANGUAGES_SPOKEN</h3>
        <pre>&lt;static&gt; object <b>LANGUAGES_SPOKEN</b></pre> 
    <ul>
       List of the languages that the person speaks as ISO 639-1 codes,
specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.LIVING_ARRANGEMENT">
    <!-- -->
    </a> <h3>LIVING_ARRANGEMENT</h3>
        <pre>&lt;static&gt; object <b>LIVING_ARRANGEMENT</b></pre> 
    <ul>
       Description of the person's living arrangement, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.LOOKING_FOR">
    <!-- -->
    </a> <h3>LOOKING_FOR</h3>
        <pre>&lt;static&gt; object <b>LOOKING_FOR</b></pre> 
    <ul>
       Person's statement about who or what they are looking for, or what they are
interested in meeting people for. Specified as an Array of opensocial.Enum
with the enum's key referencing opensocial.Enum.LookingFor.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.MOVIES">
    <!-- -->
    </a> <h3>MOVIES</h3>
        <pre>&lt;static&gt; object <b>MOVIES</b></pre> 
    <ul>
       Person's favorite movies, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.MUSIC">
    <!-- -->
    </a> <h3>MUSIC</h3>
        <pre>&lt;static&gt; object <b>MUSIC</b></pre> 
    <ul>
       Person's favorite music, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.NAME">
    <!-- -->
    </a> <h3>NAME</h3>
        <pre>&lt;static&gt; object <b>NAME</b></pre> 
    <ul>
       A opensocial.Name object containing the person's name.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.NETWORK_PRESENCE">
    <!-- -->
    </a> <h3>NETWORK_PRESENCE</h3>
        <pre>&lt;static&gt; object <b>NETWORK_PRESENCE</b></pre> 
    <ul>
       Person's current network status. Specified as an Enum with the enum's
key referencing opensocial.Enum.Presence.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.NICKNAME">
    <!-- -->
    </a> <h3>NICKNAME</h3>
        <pre>&lt;static&gt; object <b>NICKNAME</b></pre> 
    <ul>
       A String representing the person's nickname.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.PETS">
    <!-- -->
    </a> <h3>PETS</h3>
        <pre>&lt;static&gt; object <b>PETS</b></pre> 
    <ul>
       Description of the person's pets, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.PHONE_NUMBERS">
    <!-- -->
    </a> <h3>PHONE_NUMBERS</h3>
        <pre>&lt;static&gt; object <b>PHONE_NUMBERS</b></pre> 
    <ul>
       Phone numbers associated with the person, specified as an Array of
<a href="#opensocial.Phone">Phone</a>s.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.POLITICAL_VIEWS">
    <!-- -->
    </a> <h3>POLITICAL_VIEWS</h3>
        <pre>&lt;static&gt; object <b>POLITICAL_VIEWS</b></pre> 
    <ul>
       Person's political views, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.PROFILE_SONG">
    <!-- -->
    </a> <h3>PROFILE_SONG</h3>
        <pre>&lt;static&gt; object <b>PROFILE_SONG</b></pre> 
    <ul>
       Person's profile song, specified as an opensocial.Url.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.PROFILE_URL">
    <!-- -->
    </a> <h3>PROFILE_URL</h3>
        <pre>&lt;static&gt; object <b>PROFILE_URL</b></pre> 
    <ul>
       Person's profile URL, specified as a string.
This URL must be fully qualified. Relative URLs will not work in gadgets.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.PROFILE_VIDEO">
    <!-- -->
    </a> <h3>PROFILE_VIDEO</h3>
        <pre>&lt;static&gt; object <b>PROFILE_VIDEO</b></pre> 
    <ul>
       Person's profile video, specified as an opensocial.Url.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.QUOTES">
    <!-- -->
    </a> <h3>QUOTES</h3>
        <pre>&lt;static&gt; object <b>QUOTES</b></pre> 
    <ul>
       Person's favorite quotes, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.RELATIONSHIP_STATUS">
    <!-- -->
    </a> <h3>RELATIONSHIP_STATUS</h3>
        <pre>&lt;static&gt; object <b>RELATIONSHIP_STATUS</b></pre> 
    <ul>
       Person's relationship status, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.RELIGION">
    <!-- -->
    </a> <h3>RELIGION</h3>
        <pre>&lt;static&gt; object <b>RELIGION</b></pre> 
    <ul>
       Person's relgion or religious views, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.ROMANCE">
    <!-- -->
    </a> <h3>ROMANCE</h3>
        <pre>&lt;static&gt; object <b>ROMANCE</b></pre> 
    <ul>
       Person's comments about romance, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.SCARED_OF">
    <!-- -->
    </a> <h3>SCARED_OF</h3>
        <pre>&lt;static&gt; object <b>SCARED_OF</b></pre> 
    <ul>
       What the person is scared of, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.SCHOOLS">
    <!-- -->
    </a> <h3>SCHOOLS</h3>
        <pre>&lt;static&gt; object <b>SCHOOLS</b></pre> 
    <ul>
       Schools the person has attended, specified as an Array of
<a href="#opensocial.Organization">Organization</a>s.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.SEXUAL_ORIENTATION">
    <!-- -->
    </a> <h3>SEXUAL_ORIENTATION</h3>
        <pre>&lt;static&gt; object <b>SEXUAL_ORIENTATION</b></pre> 
    <ul>
       Person's sexual orientation, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.SMOKER">
    <!-- -->
    </a> <h3>SMOKER</h3>
        <pre>&lt;static&gt; object <b>SMOKER</b></pre> 
    <ul>
       Person's smoking status, specified as an opensocial.Enum with the enum's
key referencing opensocial.Enum.Smoker.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.SPORTS">
    <!-- -->
    </a> <h3>SPORTS</h3>
        <pre>&lt;static&gt; object <b>SPORTS</b></pre> 
    <ul>
       Person's favorite sports, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.STATUS">
    <!-- -->
    </a> <h3>STATUS</h3>
        <pre>&lt;static&gt; object <b>STATUS</b></pre> 
    <ul>
       Person's status, headline or shoutout, specified as a string.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.TAGS">
    <!-- -->
    </a> <h3>TAGS</h3>
        <pre>&lt;static&gt; object <b>TAGS</b></pre> 
    <ul>
       Arbitrary tags about the person, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.THUMBNAIL_URL">
    <!-- -->
    </a> <h3>THUMBNAIL_URL</h3>
        <pre>&lt;static&gt; object <b>THUMBNAIL_URL</b></pre> 
    <ul>
       Person's photo thumbnail URL, specified as a string.
This URL must be fully qualified. Relative URLs will not work in gadgets.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.TIME_ZONE">
    <!-- -->
    </a> <h3>TIME_ZONE</h3>
        <pre>&lt;static&gt; object <b>TIME_ZONE</b></pre> 
    <ul>
       Person's time zone, specified as the difference in minutes between
Greenwich Mean Time (GMT) and the user's local time. See
Date.getTimezoneOffset() in javascript for more details on this format.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.TURN_OFFS">
    <!-- -->
    </a> <h3>TURN_OFFS</h3>
        <pre>&lt;static&gt; object <b>TURN_OFFS</b></pre> 
    <ul>
       Person's turn offs, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.TURN_ONS">
    <!-- -->
    </a> <h3>TURN_ONS</h3>
        <pre>&lt;static&gt; object <b>TURN_ONS</b></pre> 
    <ul>
       Person's turn ons, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.TV_SHOWS">
    <!-- -->
    </a> <h3>TV_SHOWS</h3>
        <pre>&lt;static&gt; object <b>TV_SHOWS</b></pre> 
    <ul>
       Person's favorite TV shows, specified as an Array of strings.
Container support for this field is OPTIONAL.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Person.Field.URLS">
    <!-- -->
    </a> <h3>URLS</h3>
        <pre>&lt;static&gt; object <b>URLS</b></pre> 
    <ul>
       URLs related to the person, their webpages, or feeds. Specified as an
Array of opensocial.Url.
Container support for this field is OPTIONAL.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Phone">Class opensocial.Phone</h1>

<!-- <i>Defined in <a href="phone.src.html">phone.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Phone_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Phone_method_detail">DETAIL</a></p>


<p>
Base interface for all phone objects.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.Phone_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Phone.getField">getField</a></b>(key, opt_params) </code> 
</dt>
<dd>Gets data for this phone that is associated with the specified key.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.Phone_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.Phone.getField"> </a> <h3>getField</h3>
        <pre>String <b>getField</b>(key, opt_params)</pre> 
    <ul>
       Gets data for this phone that is associated with the specified key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to get data for;
   keys are defined in <a href="#opensocial.Phone.Field"><code>
   Phone.Field</code></a> 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Phone.Field">Static Class opensocial.Phone.Field</h1>

<!-- <i>Defined in <a href="phone.src.html">phone.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Phone.Field_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Phone.Field_field_detail">DETAIL</a></p>


<p>
All of the fields that a phone has. These are the supported keys for the
<a href="#opensocial.Phone.getField">Phone.getField()</a> method.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Phone.Field_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Phone.Field.NUMBER">NUMBER</a></b></code>
</dt>
<dd>The phone number, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Phone.Field.TYPE">TYPE</a></b></code>
</dt>
<dd>The phone number type or label, specified as a string.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Phone.Field_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Phone.Field.NUMBER">
    <!-- -->
    </a> <h3>NUMBER</h3>
        <pre>&lt;static&gt; object <b>NUMBER</b></pre> 
    <ul>
       The phone number, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Phone.Field.TYPE">
    <!-- -->
    </a> <h3>TYPE</h3>
        <pre>&lt;static&gt; object <b>TYPE</b></pre> 
    <ul>
       The phone number type or label, specified as a string.
Examples: work, my favorite store, my house, etc.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.ResponseItem">Class opensocial.ResponseItem</h1>

<!-- <i>Defined in <a href="responseitem.src.html">responseitem.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.ResponseItem_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.ResponseItem_method_detail">DETAIL</a></p>


<p>
Represents a response that was generated
by processing a data request item on the server.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.ResponseItem_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;Object
          
<b> <a href="#opensocial.ResponseItem.getData">getData</a></b>() </code> 
</dt>
<dd>Gets the response data.
</dd>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.ResponseItem.getErrorCode">getErrorCode</a></b>() </code> 
</dt>
<dd>If the request had an error, returns the error code.
</dd>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.ResponseItem.getErrorMessage">getErrorMessage</a></b>() </code> 
</dt>
<dd>If the request had an error, returns the error message.
</dd>

<dt><code>
             &nbsp;opensocial.DataRequest
          
<b> <a href="#opensocial.ResponseItem.getOriginalDataRequest">getOriginalDataRequest</a></b>() </code> 
</dt>
<dd>Returns the original data request.
</dd>

<dt><code>
             &nbsp;Boolean
          
<b> <a href="#opensocial.ResponseItem.hadError">hadError</a></b>() </code> 
</dt>
<dd>Returns true if there was an error in fetching this data from the server.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.ResponseItem_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.ResponseItem.getData"> </a> <h3>getData</h3>
        <pre>Object <b>getData</b>()</pre> 
    <ul>
       Gets the response data.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Object</i>&nbsp;</code> The requested value calculated by the server; the type of
   this value is defined by the type of request that was made
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.ResponseItem.getErrorCode"> </a> <h3>getErrorCode</h3>
        <pre>String <b>getErrorCode</b>()</pre> 
    <ul>
       If the request had an error, returns the error code.
The error code can be container-specific
or one of the values defined by
<a href="#opensocial.ResponseItem.Error"><code>Error</code></a>.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The error code, or null if no error occurred
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.ResponseItem.getErrorMessage"> </a> <h3>getErrorMessage</h3>
        <pre>String <b>getErrorMessage</b>()</pre> 
    <ul>
       If the request had an error, returns the error message.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> A human-readable description of the error that occurred;
   can be null, even if an error occurred
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.ResponseItem.getOriginalDataRequest"> </a> <h3>getOriginalDataRequest</h3>
        <pre>opensocial.DataRequest <b>getOriginalDataRequest</b>()</pre> 
    <ul>
       Returns the original data request.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>opensocial.DataRequest</i>&nbsp;</code> The data request used to fetch this data
   response
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->

    <a name="opensocial.ResponseItem.hadError"> </a> <h3>hadError</h3>
        <pre>Boolean <b>hadError</b>()</pre> 
    <ul>
       Returns true if there was an error in fetching this data from the server.
    </ul>
    <!-- METHOD PARAMETERS START -->
    
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>Boolean</i>&nbsp;</code> True if there was an error; otherwise, false
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.ResponseItem.Error">Static Class opensocial.ResponseItem.Error</h1>

<!-- <i>Defined in <a href="responseitem.src.html">responseitem.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.ResponseItem.Error_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.ResponseItem.Error_field_detail">DETAIL</a></p>


<p>
Error codes that a response item can return.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.ResponseItem.Error_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.ResponseItem.Error.BAD_REQUEST">BAD_REQUEST</a></b></code>
</dt>
<dd>The request was invalid.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.ResponseItem.Error.FORBIDDEN">FORBIDDEN</a></b></code>
</dt>
<dd>The gadget can never have access to the requested data.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.ResponseItem.Error.INTERNAL_ERROR">INTERNAL_ERROR</a></b></code>
</dt>
<dd>The request encountered an unexpected condition that
prevented it from fulfilling the request.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.ResponseItem.Error.LIMIT_EXCEEDED">LIMIT_EXCEEDED</a></b></code>
</dt>
<dd>The gadget exceeded a quota on the request.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.ResponseItem.Error.NOT_IMPLEMENTED">NOT_IMPLEMENTED</a></b></code>
</dt>
<dd>This container does not support the request that was made.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.ResponseItem.Error.UNAUTHORIZED">UNAUTHORIZED</a></b></code>
</dt>
<dd>The gadget does not have access to the requested data.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.ResponseItem.Error_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.ResponseItem.Error.BAD_REQUEST">
    <!-- -->
    </a> <h3>BAD_REQUEST</h3>
        <pre>&lt;static&gt; object <b>BAD_REQUEST</b></pre> 
    <ul>
       The request was invalid. Example: 'max' was -1.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.ResponseItem.Error.FORBIDDEN">
    <!-- -->
    </a> <h3>FORBIDDEN</h3>
        <pre>&lt;static&gt; object <b>FORBIDDEN</b></pre> 
    <ul>
       The gadget can never have access to the requested data.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.ResponseItem.Error.INTERNAL_ERROR">
    <!-- -->
    </a> <h3>INTERNAL_ERROR</h3>
        <pre>&lt;static&gt; object <b>INTERNAL_ERROR</b></pre> 
    <ul>
       The request encountered an unexpected condition that
prevented it from fulfilling the request.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.ResponseItem.Error.LIMIT_EXCEEDED">
    <!-- -->
    </a> <h3>LIMIT_EXCEEDED</h3>
        <pre>&lt;static&gt; object <b>LIMIT_EXCEEDED</b></pre> 
    <ul>
       The gadget exceeded a quota on the request. Example quotas include a
max number of calls per day, calls per user per day, calls within a
certain time period and so forth.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.ResponseItem.Error.NOT_IMPLEMENTED">
    <!-- -->
    </a> <h3>NOT_IMPLEMENTED</h3>
        <pre>&lt;static&gt; object <b>NOT_IMPLEMENTED</b></pre> 
    <ul>
       This container does not support the request that was made.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.ResponseItem.Error.UNAUTHORIZED">
    <!-- -->
    </a> <h3>UNAUTHORIZED</h3>
        <pre>&lt;static&gt; object <b>UNAUTHORIZED</b></pre> 
    <ul>
       The gadget does not have access to the requested data.
To get access, use
<a href="#opensocial.requestPermission">
opensocial.requestPermission()</a>.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Url">Class opensocial.Url</h1>

<!-- <i>Defined in <a href="url.src.html">url.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Url_method_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Url_method_detail">DETAIL</a></p>


<p>
Base interface for all URL objects.</p>





<!-- =========== FIELD SUMMARY =========== -->

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<a name="opensocial.Url_method_summary"> </a> 
<h2>Method Summary</h2>
<dl>

<dt><code>
             &nbsp;String
          
<b> <a href="#opensocial.Url.getField">getField</a></b>(key, opt_params) </code> 
</dt>
<dd>Gets data for this URL that is associated with the specified key.
</dd>

</dl>
&nbsp;

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<a name="opensocial.Url_method_detail"> </a> 
<h2>Method Detail</h2>


    <a name="opensocial.Url.getField"> </a> <h3>getField</h3>
        <pre>String <b>getField</b>(key, opt_params)</pre> 
    <ul>
       Gets data for this URL that is associated with the specified key.
    </ul>
    <!-- METHOD PARAMETERS START -->
    <ul>
        <b>Parameters:</b>
        <ul>
            <code><i>String</i>&nbsp;key </code> - The key to get data for;
   keys are defined in <a href="#opensocial.Url.Field"><code>
   Url.Field</code></a> 
        </ul>
        <ul>
            <code><i>Map.&lt;opensocial.DataRequest.DataRequestFields, Object&gt;</i>&nbsp;opt_params </code> - Additional
   <a href="#opensocial.DataRequest.DataRequestFields">params</a>
   to pass to the request. 
        </ul>
    </ul>
    <!-- METHOD PARAMETERS END -->
    <!-- ADDITIONAL ATTRIBUTES START -->
    <ul>
        <b>Returns:</b>
        <ul>
            <code><i>String</i>&nbsp;</code> The data
        </ul>
    </ul>
    
    <!-- ADDITIONAL ATTRIBUTES  END -->


<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>






<h1 id="opensocial.Url.Field">Static Class opensocial.Url.Field</h1>

<!-- <i>Defined in <a href="url.src.html">url.js</a></i> -->


<p class="summaryDetailLink">&nbsp;<a href="#opensocial.Url.Field_field_summary">SUMMARY</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#opensocial.Url.Field_field_detail">DETAIL</a></p>


<p>
All of the fields that a URL has. These are the supported keys for the
<a href="#opensocial.Url.getField">Url.getField()</a> method.</p>





<!-- =========== FIELD SUMMARY =========== -->

<a name="opensocial.Url.Field_field_summary"> </a> 
<h2>Field Summary</h2>
<dl>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Url.Field.ADDRESS">ADDRESS</a></b></code>
</dt>
<dd>The address the URL points to, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Url.Field.LINK_TEXT">LINK_TEXT</a></b></code>
</dt>
<dd>The text of the link, specified as a string.
</dd>

<dt>
<code>&lt;static&gt;&nbsp;object
<b><a href="#opensocial.Url.Field.TYPE">TYPE</a></b></code>
</dt>
<dd>The URL number type or label, specified as a string.
</dd>

</dl>
&nbsp;

<!-- =========== END FIELD SUMMARY =========== -->



<!-- ========== METHOD SUMMARY =========== -->

<!-- ========== END METHOD SUMMARY =========== -->
<!-- ========== EVENT SUMMARY =========== -->

<!-- ========== END EVENT SUMMARY =========== -->
<!-- ========== INHERITED METHODS SUMMARY =========== -->



<!-- ========== END INHERITED METHODS SUMMARY =========== -->

<!-- ============ FIELD DETAIL START ========= -->

<a name="opensocial.Url.Field_field_detail"> </a> 
<h2>Field Detail</h2>


    <!-- One single method detail entry -->
    <a name="opensocial.Url.Field.ADDRESS">
    <!-- -->
    </a> <h3>ADDRESS</h3>
        <pre>&lt;static&gt; object <b>ADDRESS</b></pre> 
    <ul>
       The address the URL points to, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Url.Field.LINK_TEXT">
    <!-- -->
    </a> <h3>LINK_TEXT</h3>
        <pre>&lt;static&gt; object <b>LINK_TEXT</b></pre> 
    <ul>
       The text of the link, specified as a string.
    </ul>

    <!-- One single method detail entry -->
    <a name="opensocial.Url.Field.TYPE">
    <!-- -->
    </a> <h3>TYPE</h3>
        <pre>&lt;static&gt; object <b>TYPE</b></pre> 
    <ul>
       The URL number type or label, specified as a string.
Examples: work, blog feed, website, etc.
    </ul>


<!-- ============ FIELD DETAIL END ========== -->



<!-- ============ METHOD DETAIL START ======= -->

<!-- ============ METHOD DETAIL END ========== -->

<!-- ============ EVENT DETAIL START ======= -->


<!-- ============ EVENT DETAIL END ========== -->

<p class="backtotop"><a href="#top">Back to top</a></p>

 <!-- outer most for loop !-->

   
      <div class="" style="height: 59239px;" id="gc-collapsible"></div></div><!-- end gc-pagecontent -->
   </div><!-- end gooey wrapper -->

    </div> <!-- end codesite content -->

<div id="gc-footer" dir="ltr"> 
  <div class="text">
    
      <div class="notice"><div id="notice" style="text-align: center;">
  Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
  the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/2.5/">Creative Commons
  Attribution 2.5 License</a>.
<!-- <rdf:RDF xmlns="http://web.resource.org/cc/" 
              xmlns:dc="http://purl.org/dc/elements/1.1/"
              xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
  <Work rdf:about="">
    <license rdf:resource="http://creativecommons.org/licenses/by/2.5/" />
  </Work>
  <License rdf:about="http://creativecommons.org/licenses/by/2.5/">
    <permits rdf:resource="http://web.resource.org/cc/Reproduction"/>
    <permits rdf:resource="http://web.resource.org/cc/Distribution"/>
    <requires rdf:resource="http://web.resource.org/cc/Notice"/>
    <requires rdf:resource="http://web.resource.org/cc/Attribution"/>
    <permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/>
  </License>
</rdf:RDF> -->
</div>
</div>
    
    ©2008 Google -
    <a href="http://code.google.com/">Code Home</a> -
    <a href="http://www.google.com/accounts/TOS">Site Terms of Service</a> -
    <a href="http://www.google.com/privacy.html">Privacy Policy</a> -
    <a href="http://code.google.com/more/">Site Directory</a>
     <br>
     <br>
    Google Code offered in:  
    <a href="http://code.google.com/intl/zh-CN/">中文</a> - 
    <a href="http://code.google.com/">English</a> - 
    <a href="http://code.google.com/intl/pt-BR/">Português</a> - 
    <a href="http://code.google.com/intl/ru/">Pусский</a> - 
    <a href="http://code.google.com/intl/es/">Español</a> - 
    <a href="http://code.google.com/intl/ja/">日本語</a> </div><!-- end gc-footer -->
  </div>
</div><!-- end gc-containter -->
<script src="OpenSocial%20API%20Reference%20%28v0.8%29%20-%20OpenSocial%20-%20Google%20Code_opensocial_files/ga.js" type="text/javascript">
</script>
<script type="text/javascript">
  try {
    var pageTracker = _gat._getTracker("UA-18071-1");
    pageTracker._setAllowAnchor(true);
    pageTracker._initData();
    pageTracker._trackPageview(); 
  } catch(e) {}
</script>




  <select size="6" style="position: absolute; display: none;" class="fauxSelect"><option value="zh-CN">中文 (简体)</option><option value="en">English</option><option value="pt-BR">Português (Brasil)</option><option value="ru">Pусский</option><option value="es">Español</option><option value="ja">日本語</option></select><div style="display: none; left: 263px; top: 1568px;" class="" id="gc-collapsible-arrow"></div><div id="cs-searchresults"><div id="cs-recommended">Suggestions</div><div id="searchResult1"></div><div id="searchResult2"></div><div id="searchResult3"></div><div id="searchResult4"></div><div id="searchResult5"></div><div id="searchResult6"></div><div id="searchResult7"></div></div></body></html>